c1package

National API with C1 Package
Parameters
AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

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

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

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

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

EmrSessionToken
string required

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

InstanceToken
string optional

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

Logout EMR session
IncludeDeleted
boolean optional

If true it will make sure deleted items are also returned

Headers
If-Modified-Since
string date optional

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

Authorization
string required

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

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

Not found

EncounterSummaryAggregateResponse

Encounter Summary Aggregate Response

All of
Object
Payload
All of
Object
Entities

Sample Empty Payload

{
    "ProcessingTimeMilliseconds": 1,
    "ResponseStatus": {
        "ErrorCode": "",
        "Message": "",
        "StackTrace": "",
        "Errors": [
            {
                "ErrorCode": "",
                "FieldName": "",
                "Message": "",
                "Meta": {}
            }
        ],
        "Meta": {}
    },
    "ResourceType": "",
    "Payload": {
        "MoreRecords": false,
        "TotalRecordCount": 1,
        "Entities": [
            {
                "Id": "",
                "Descriptor": "",
                "Metadata": {
                    "Type": "",
                    "Path": ""
                },
                "Assigner": "",
                "Patient": {
                    "Id": "",
                    "Descriptor": "",
                    "Metadata": {
                        "Type": "",
                        "Path": ""
                    },
                    "Assigner": "",
                    "Title": "",
                    "FirstName": "",
                    "GoesByName": "",
                    "MiddleName": "",
                    "LastName": "",
                    "Language": "",
                    "Initials": "",
                    "ContactInfo": {
                        "Type": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "Emails": [
                            {
                                "PreferredMethodOfContact": true,
                                "Type": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "EmailAddress": "",
                                "Primary": true
                            }
                        ],
                        "PhoneNumbers": [
                            {
                                "PreferredMethodOfContact": true,
                                "Type": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "PhoneNumber": "",
                                "FormattedPhoneNumber": "",
                                "Extension": "",
                                "Primary": true
                            }
                        ],
                        "FaxNumbers": [
                            {
                                "PreferredMethodOfContact": true,
                                "Type": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "FaxNumber": "",
                                "FormattedFaxNumber": "",
                                "Primary": true
                            }
                        ],
                        "Addresses": [
                            {
                                "PreferredMethodOfContact": true,
                                "Type": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "AddressLine1": "",
                                "AddressLine2": "",
                                "AddressLine3": "",
                                "City": "",
                                "Province": "",
                                "PostalCode": "",
                                "Country": "",
                                "Primary": true,
                                "Name": ""
                            }
                        ]
                    },
                    "MaidenName": "",
                    "RestrictedAccess": true,
                    "Demographics": {
                        "BirthDate": "",
                        "Gender": "M",
                        "PHN": "",
                        "PHNVersionCode": "",
                        "DeceasedDate": {
                            "Date": "",
                            "Precision": "Year"
                        }
                    },
                    "MedicalSummary": {
                        "CurrentMedications": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Name": "",
                                "GenericName": "",
                                "Code": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Form": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "StrengthValue": 1,
                                "StrengthUnit": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Details": "",
                                "Indication": "",
                                "PrescribedBy": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "PrescribedDate": "",
                                "PrescribedDateFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "EffectiveDate": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "CompletedDate": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "Status": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "StopReason": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "TreatmentType": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Dosage": "",
                                "DosageInstruction": [
                                    {
                                        "Sequence": 1,
                                        "Text": "",
                                        "DoseRangeLow": 1,
                                        "DoseRangeHigh": 1,
                                        "DoseUnits": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Frequency": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Duration": 1,
                                        "DurationUnit": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "AsNeeded": true
                                    }
                                ],
                                "PatientInstruction": "",
                                "Quantity": 1,
                                "QuantityUnit": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Route": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "RateRatioAmount": 1,
                                "RateRatioTime": 1,
                                "RateRatioTimeUnit": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "NumberOfRepeatsAllowed": 1,
                                "SubstitutionsAllowed": true,
                                "LastDispenseInClinic": {
                                    "Date": "",
                                    "Precision": "Year"
                                }
                            }
                        ],
                        "CurrentAllergies": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Category": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Substance": "",
                                "SubstanceCode": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Reaction": "",
                                "ReactionType": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Certainty": "mild",
                                "Date": "",
                                "DateFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "ClinicalStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "VerificationStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Notes": ""
                            }
                        ],
                        "CurrentProblems": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Name": "",
                                "Code": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Category": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "ClinicalStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "ConfirmationStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "PersistenceStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Severity": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Date": "",
                                "DateFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "DateDescription": "",
                                "Notes": "",
                                "DateOfOnset": "",
                                "DateOfOnsetFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "DateOfAbatement": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "Outcome": ""
                            }
                        ],
                        "Procedures": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Category": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Name": "",
                                "Code": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Date": "",
                                "DateFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "DateDescription": "",
                                "Practitioner": "",
                                "Notes": ""
                            }
                        ],
                        "FamilyHistory": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Problem": "",
                                "RelationName": "",
                                "DateNoted": ""
                            }
                        ],
                        "Vaccinations": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Name": "",
                                "Code": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Date": "",
                                "DateFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "DateDescription": "",
                                "Reaction": "",
                                "Type": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Dose": 1,
                                "Site": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Route": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Manufacturer": "",
                                "LotNumber": "",
                                "ExpiryDate": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "NotGiven": true,
                                "Notes": ""
                            }
                        ],
                        "HarmfulSubstances": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Type": "",
                                "TypeCode": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Details": "",
                                "EffectiveStartDateTime": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "EffectiveEndDateTime": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "Notes": ""
                            }
                        ],
                        "Personal": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Trait": "",
                                "Details": ""
                            }
                        ],
                        "PreviousMedications": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Name": "",
                                "GenericName": "",
                                "Code": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Form": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "StrengthValue": 1,
                                "StrengthUnit": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Details": "",
                                "Indication": "",
                                "PrescribedBy": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "PrescribedDate": "",
                                "PrescribedDateFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "EffectiveDate": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "CompletedDate": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "Status": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "StopReason": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "TreatmentType": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Dosage": "",
                                "DosageInstruction": [
                                    {
                                        "Sequence": 1,
                                        "Text": "",
                                        "DoseRangeLow": 1,
                                        "DoseRangeHigh": 1,
                                        "DoseUnits": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Frequency": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Duration": 1,
                                        "DurationUnit": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "AsNeeded": true
                                    }
                                ],
                                "PatientInstruction": "",
                                "Quantity": 1,
                                "QuantityUnit": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Route": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "RateRatioAmount": 1,
                                "RateRatioTime": 1,
                                "RateRatioTimeUnit": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "NumberOfRepeatsAllowed": 1,
                                "SubstitutionsAllowed": true,
                                "LastDispenseInClinic": {
                                    "Date": "",
                                    "Precision": "Year"
                                }
                            }
                        ],
                        "InactiveAllergies": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Category": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Substance": "",
                                "SubstanceCode": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Reaction": "",
                                "ReactionType": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Certainty": "mild",
                                "Date": "",
                                "DateFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "ClinicalStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "VerificationStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Notes": ""
                            }
                        ],
                        "InactiveProblems": [
                            {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "Name": "",
                                "Code": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Category": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "ClinicalStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "ConfirmationStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "PersistenceStatus": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Severity": {
                                    "Coding": [
                                        {
                                            "System": "",
                                            "Code": "",
                                            "Display": ""
                                        }
                                    ],
                                    "Text": ""
                                },
                                "Date": "",
                                "DateFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "DateDescription": "",
                                "Notes": "",
                                "DateOfOnset": "",
                                "DateOfOnsetFD": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "DateOfAbatement": {
                                    "Date": "",
                                    "Precision": "Year"
                                },
                                "Outcome": ""
                            }
                        ]
                    },
                    "JournalItems": [
                        {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "NewEventDate": {
                                "Date": "",
                                "Precision": "Year"
                            },
                            "EventDate": "",
                            "CreatedDate": "",
                            "CreatedBy": {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "ReferenceType": ""
                            },
                            "LastModifiedDate": "",
                            "LastModifiedBy": {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "ReferenceType": ""
                            }
                        }
                    ],
                    "CareTeam": {
                        "CareTeamProvider": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "PrimaryProvider": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "AlternateProvider": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "Pharmacy": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "FamilyMD": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "Location": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        }
                    },
                    "OtherInfo": {
                        "BillingProvince": "AB",
                        "Notes": "",
                        "ChartId": "",
                        "Rostered": true,
                        "RosteredDate": {
                            "Date": "",
                            "Precision": "Year"
                        }
                    },
                    "Active": true
                },
                "EncounterSummary": {
                    "Id": "",
                    "Descriptor": "",
                    "Metadata": {
                        "Type": "",
                        "Path": ""
                    },
                    "Assigner": "",
                    "Provider": {
                        "Id": "",
                        "Descriptor": "",
                        "Metadata": {
                            "Type": "",
                            "Path": ""
                        },
                        "Assigner": "",
                        "ReferenceType": ""
                    },
                    "Location": {
                        "Coding": [
                            {
                                "System": "",
                                "Code": "",
                                "Display": ""
                            }
                        ],
                        "Text": ""
                    },
                    "Schedule": {
                        "Id": "",
                        "Descriptor": "",
                        "Metadata": {
                            "Type": "",
                            "Path": ""
                        },
                        "Assigner": "",
                        "ReferenceType": ""
                    },
                    "Appointment": {
                        "Id": "",
                        "Descriptor": "",
                        "Metadata": {
                            "Type": "",
                            "Path": ""
                        },
                        "Assigner": "",
                        "ReferenceType": ""
                    },
                    "Start": {
                        "Date": "",
                        "Precision": "Year"
                    },
                    "End": {
                        "Date": "",
                        "Precision": "Year"
                    },
                    "Reason": {
                        "Coding": [
                            {
                                "System": "",
                                "Code": "",
                                "Display": ""
                            }
                        ],
                        "Text": ""
                    },
                    "Diagnosis": [
                        {
                            "Coding": [
                                {
                                    "System": "",
                                    "Code": "",
                                    "Display": ""
                                }
                            ],
                            "Text": ""
                        }
                    ],
                    "Type": {
                        "Coding": [
                            {
                                "System": "",
                                "Code": "",
                                "Display": ""
                            }
                        ],
                        "Text": ""
                    },
                    "AccountType": {
                        "Coding": [
                            {
                                "System": "",
                                "Code": "",
                                "Display": ""
                            }
                        ],
                        "Text": ""
                    },
                    "Observations": [
                        {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "Category": {
                                "Coding": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Text": ""
                            },
                            "Code": {
                                "Coding": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Text": ""
                            },
                            "GroupName": "",
                            "ValueString": "",
                            "ValueQuantity": 1,
                            "ValueQuantityUnits": {
                                "Coding": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Text": ""
                            },
                            "EffectiveDateTime": {
                                "Date": "",
                                "Precision": "Year"
                            },
                            "ReferenceRange": "",
                            "ReferenceRangeLow": 1,
                            "ReferenceRangeLowUnits": {
                                "Coding": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Text": ""
                            },
                            "ReferenceRangeHigh": 1,
                            "ReferenceRangeHighUnits": {
                                "Coding": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Text": ""
                            },
                            "Interpretation": {
                                "Coding": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Text": ""
                            },
                            "Status": {
                                "Coding": [
                                    {
                                        "System": "",
                                        "Code": "",
                                        "Display": ""
                                    }
                                ],
                                "Text": ""
                            },
                            "IsRequest": true
                        }
                    ],
                    "ReferralRequest": {
                        "Id": "",
                        "Descriptor": "",
                        "Metadata": {
                            "Type": "",
                            "Path": ""
                        },
                        "Assigner": "",
                        "Type": {
                            "Coding": [
                                {
                                    "System": "",
                                    "Code": "",
                                    "Display": ""
                                }
                            ],
                            "Text": ""
                        },
                        "Description": "",
                        "ServiceRequested": {
                            "Coding": [
                                {
                                    "System": "",
                                    "Code": "",
                                    "Display": ""
                                }
                            ],
                            "Text": ""
                        },
                        "Recipient": "",
                        "OccurrenceDateTime": {
                            "Date": "",
                            "Precision": "Year"
                        }
                    }
                },
                "Consultants": [
                    {
                        "Id": "",
                        "Descriptor": "",
                        "Metadata": {
                            "Type": "",
                            "Path": ""
                        },
                        "Assigner": "",
                        "Title": "",
                        "FirstName": "",
                        "GoesByName": "",
                        "MiddleName": "",
                        "LastName": "",
                        "Language": "",
                        "Initials": "",
                        "ContactInfo": {
                            "Type": {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "ReferenceType": ""
                            },
                            "Emails": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "EmailAddress": "",
                                    "Primary": true
                                }
                            ],
                            "PhoneNumbers": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "PhoneNumber": "",
                                    "FormattedPhoneNumber": "",
                                    "Extension": "",
                                    "Primary": true
                                }
                            ],
                            "FaxNumbers": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "FaxNumber": "",
                                    "FormattedFaxNumber": "",
                                    "Primary": true
                                }
                            ],
                            "Addresses": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "AddressLine1": "",
                                    "AddressLine2": "",
                                    "AddressLine3": "",
                                    "City": "",
                                    "Province": "",
                                    "PostalCode": "",
                                    "Country": "",
                                    "Primary": true,
                                    "Name": ""
                                }
                            ]
                        },
                        "Credentials": "",
                        "Specialty": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "RegistrationNumber": "",
                        "RegistrationNumberAssigningAuthority": {
                            "Coding": [
                                {
                                    "System": "",
                                    "Code": "",
                                    "Display": ""
                                }
                            ],
                            "Text": ""
                        },
                        "Department": "",
                        "Notes": "",
                        "BuildingName": "",
                        "BuildingType": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "SortDescriptor": ""
                    }
                ],
                "Providers": [
                    {
                        "Id": "",
                        "Descriptor": "",
                        "Metadata": {
                            "Type": "",
                            "Path": ""
                        },
                        "Assigner": "",
                        "Title": "",
                        "FirstName": "",
                        "GoesByName": "",
                        "MiddleName": "",
                        "LastName": "",
                        "Language": "",
                        "Initials": "",
                        "ContactInfo": {
                            "Type": {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "ReferenceType": ""
                            },
                            "Emails": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "EmailAddress": "",
                                    "Primary": true
                                }
                            ],
                            "PhoneNumbers": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "PhoneNumber": "",
                                    "FormattedPhoneNumber": "",
                                    "Extension": "",
                                    "Primary": true
                                }
                            ],
                            "FaxNumbers": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "FaxNumber": "",
                                    "FormattedFaxNumber": "",
                                    "Primary": true
                                }
                            ],
                            "Addresses": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "AddressLine1": "",
                                    "AddressLine2": "",
                                    "AddressLine3": "",
                                    "City": "",
                                    "Province": "",
                                    "PostalCode": "",
                                    "Country": "",
                                    "Primary": true,
                                    "Name": ""
                                }
                            ]
                        },
                        "Credentials": "",
                        "Specialty": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "RegistrationNumber": "",
                        "RegistrationNumberAssigningAuthority": {
                            "Coding": [
                                {
                                    "System": "",
                                    "Code": "",
                                    "Display": ""
                                }
                            ],
                            "Text": ""
                        },
                        "Department": "",
                        "Notes": "",
                        "BuildingName": "",
                        "BuildingType": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "SortDescriptor": "",
                        "DailySchedules": [
                            {
                                "StartTime": "",
                                "EndTime": "",
                                "Scheduleable": true
                            }
                        ],
                        "ScheduleId": ""
                    }
                ],
                "ClinicStaffs": [
                    {
                        "Id": "",
                        "Descriptor": "",
                        "Metadata": {
                            "Type": "",
                            "Path": ""
                        },
                        "Assigner": "",
                        "Title": "",
                        "FirstName": "",
                        "GoesByName": "",
                        "MiddleName": "",
                        "LastName": "",
                        "Language": "",
                        "Initials": "",
                        "ContactInfo": {
                            "Type": {
                                "Id": "",
                                "Descriptor": "",
                                "Metadata": {
                                    "Type": "",
                                    "Path": ""
                                },
                                "Assigner": "",
                                "ReferenceType": ""
                            },
                            "Emails": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "EmailAddress": "",
                                    "Primary": true
                                }
                            ],
                            "PhoneNumbers": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "PhoneNumber": "",
                                    "FormattedPhoneNumber": "",
                                    "Extension": "",
                                    "Primary": true
                                }
                            ],
                            "FaxNumbers": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "FaxNumber": "",
                                    "FormattedFaxNumber": "",
                                    "Primary": true
                                }
                            ],
                            "Addresses": [
                                {
                                    "PreferredMethodOfContact": true,
                                    "Type": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "AddressLine1": "",
                                    "AddressLine2": "",
                                    "AddressLine3": "",
                                    "City": "",
                                    "Province": "",
                                    "PostalCode": "",
                                    "Country": "",
                                    "Primary": true,
                                    "Name": ""
                                }
                            ]
                        },
                        "LocationId": 1,
                        "LocationName": ""
                    }
                ],
                "Schedules": [
                    {
                        "Id": "",
                        "Descriptor": "",
                        "Metadata": {
                            "Type": "",
                            "Path": ""
                        },
                        "Assigner": "",
                        "Name": ""
                    }
                ],
                "Appointments": [
                    {
                        "Id": "",
                        "Descriptor": "",
                        "Metadata": {
                            "Type": "",
                            "Path": ""
                        },
                        "Assigner": "",
                        "Provider": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "Patient": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "Title": "",
                            "FirstName": "",
                            "GoesByName": "",
                            "MiddleName": "",
                            "LastName": "",
                            "Language": "",
                            "Initials": "",
                            "ContactInfo": {
                                "Type": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "Emails": [
                                    {
                                        "PreferredMethodOfContact": true,
                                        "Type": {
                                            "Id": "",
                                            "Descriptor": "",
                                            "Metadata": {
                                                "Type": "",
                                                "Path": ""
                                            },
                                            "Assigner": "",
                                            "ReferenceType": ""
                                        },
                                        "EmailAddress": "",
                                        "Primary": true
                                    }
                                ],
                                "PhoneNumbers": [
                                    {
                                        "PreferredMethodOfContact": true,
                                        "Type": {
                                            "Id": "",
                                            "Descriptor": "",
                                            "Metadata": {
                                                "Type": "",
                                                "Path": ""
                                            },
                                            "Assigner": "",
                                            "ReferenceType": ""
                                        },
                                        "PhoneNumber": "",
                                        "FormattedPhoneNumber": "",
                                        "Extension": "",
                                        "Primary": true
                                    }
                                ],
                                "FaxNumbers": [
                                    {
                                        "PreferredMethodOfContact": true,
                                        "Type": {
                                            "Id": "",
                                            "Descriptor": "",
                                            "Metadata": {
                                                "Type": "",
                                                "Path": ""
                                            },
                                            "Assigner": "",
                                            "ReferenceType": ""
                                        },
                                        "FaxNumber": "",
                                        "FormattedFaxNumber": "",
                                        "Primary": true
                                    }
                                ],
                                "Addresses": [
                                    {
                                        "PreferredMethodOfContact": true,
                                        "Type": {
                                            "Id": "",
                                            "Descriptor": "",
                                            "Metadata": {
                                                "Type": "",
                                                "Path": ""
                                            },
                                            "Assigner": "",
                                            "ReferenceType": ""
                                        },
                                        "AddressLine1": "",
                                        "AddressLine2": "",
                                        "AddressLine3": "",
                                        "City": "",
                                        "Province": "",
                                        "PostalCode": "",
                                        "Country": "",
                                        "Primary": true,
                                        "Name": ""
                                    }
                                ]
                            },
                            "MaidenName": "",
                            "RestrictedAccess": true,
                            "Demographics": {
                                "BirthDate": "",
                                "Gender": "M",
                                "PHN": "",
                                "PHNVersionCode": "",
                                "DeceasedDate": {
                                    "Date": "",
                                    "Precision": "Year"
                                }
                            },
                            "MedicalSummary": {
                                "CurrentMedications": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Name": "",
                                        "GenericName": "",
                                        "Code": [
                                            {
                                                "System": "",
                                                "Code": "",
                                                "Display": ""
                                            }
                                        ],
                                        "Form": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "StrengthValue": 1,
                                        "StrengthUnit": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Details": "",
                                        "Indication": "",
                                        "PrescribedBy": {
                                            "Id": "",
                                            "Descriptor": "",
                                            "Metadata": {
                                                "Type": "",
                                                "Path": ""
                                            },
                                            "Assigner": "",
                                            "ReferenceType": ""
                                        },
                                        "PrescribedDate": "",
                                        "PrescribedDateFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "EffectiveDate": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "CompletedDate": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "Status": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "StopReason": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "TreatmentType": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Dosage": "",
                                        "DosageInstruction": [
                                            {
                                                "Sequence": 1,
                                                "Text": "",
                                                "DoseRangeLow": 1,
                                                "DoseRangeHigh": 1,
                                                "DoseUnits": {
                                                    "Coding": [
                                                        {
                                                            "System": "",
                                                            "Code": "",
                                                            "Display": ""
                                                        }
                                                    ],
                                                    "Text": ""
                                                },
                                                "Frequency": {
                                                    "Coding": [
                                                        {
                                                            "System": "",
                                                            "Code": "",
                                                            "Display": ""
                                                        }
                                                    ],
                                                    "Text": ""
                                                },
                                                "Duration": 1,
                                                "DurationUnit": {
                                                    "Coding": [
                                                        {
                                                            "System": "",
                                                            "Code": "",
                                                            "Display": ""
                                                        }
                                                    ],
                                                    "Text": ""
                                                },
                                                "AsNeeded": true
                                            }
                                        ],
                                        "PatientInstruction": "",
                                        "Quantity": 1,
                                        "QuantityUnit": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Route": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "RateRatioAmount": 1,
                                        "RateRatioTime": 1,
                                        "RateRatioTimeUnit": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "NumberOfRepeatsAllowed": 1,
                                        "SubstitutionsAllowed": true,
                                        "LastDispenseInClinic": {
                                            "Date": "",
                                            "Precision": "Year"
                                        }
                                    }
                                ],
                                "CurrentAllergies": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Category": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Substance": "",
                                        "SubstanceCode": [
                                            {
                                                "System": "",
                                                "Code": "",
                                                "Display": ""
                                            }
                                        ],
                                        "Reaction": "",
                                        "ReactionType": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Certainty": "mild",
                                        "Date": "",
                                        "DateFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "ClinicalStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "VerificationStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Notes": ""
                                    }
                                ],
                                "CurrentProblems": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Name": "",
                                        "Code": [
                                            {
                                                "System": "",
                                                "Code": "",
                                                "Display": ""
                                            }
                                        ],
                                        "Category": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "ClinicalStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "ConfirmationStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "PersistenceStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Severity": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Date": "",
                                        "DateFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "DateDescription": "",
                                        "Notes": "",
                                        "DateOfOnset": "",
                                        "DateOfOnsetFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "DateOfAbatement": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "Outcome": ""
                                    }
                                ],
                                "Procedures": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Category": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Name": "",
                                        "Code": [
                                            {
                                                "System": "",
                                                "Code": "",
                                                "Display": ""
                                            }
                                        ],
                                        "Date": "",
                                        "DateFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "DateDescription": "",
                                        "Practitioner": "",
                                        "Notes": ""
                                    }
                                ],
                                "FamilyHistory": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Problem": "",
                                        "RelationName": "",
                                        "DateNoted": ""
                                    }
                                ],
                                "Vaccinations": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Name": "",
                                        "Code": [
                                            {
                                                "System": "",
                                                "Code": "",
                                                "Display": ""
                                            }
                                        ],
                                        "Date": "",
                                        "DateFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "DateDescription": "",
                                        "Reaction": "",
                                        "Type": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Dose": 1,
                                        "Site": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Route": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Manufacturer": "",
                                        "LotNumber": "",
                                        "ExpiryDate": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "NotGiven": true,
                                        "Notes": ""
                                    }
                                ],
                                "HarmfulSubstances": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Type": "",
                                        "TypeCode": [
                                            {
                                                "System": "",
                                                "Code": "",
                                                "Display": ""
                                            }
                                        ],
                                        "Details": "",
                                        "EffectiveStartDateTime": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "EffectiveEndDateTime": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "Notes": ""
                                    }
                                ],
                                "Personal": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Trait": "",
                                        "Details": ""
                                    }
                                ],
                                "PreviousMedications": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Name": "",
                                        "GenericName": "",
                                        "Code": [
                                            {
                                                "System": "",
                                                "Code": "",
                                                "Display": ""
                                            }
                                        ],
                                        "Form": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "StrengthValue": 1,
                                        "StrengthUnit": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Details": "",
                                        "Indication": "",
                                        "PrescribedBy": {
                                            "Id": "",
                                            "Descriptor": "",
                                            "Metadata": {
                                                "Type": "",
                                                "Path": ""
                                            },
                                            "Assigner": "",
                                            "ReferenceType": ""
                                        },
                                        "PrescribedDate": "",
                                        "PrescribedDateFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "EffectiveDate": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "CompletedDate": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "Status": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "StopReason": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "TreatmentType": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Dosage": "",
                                        "DosageInstruction": [
                                            {
                                                "Sequence": 1,
                                                "Text": "",
                                                "DoseRangeLow": 1,
                                                "DoseRangeHigh": 1,
                                                "DoseUnits": {
                                                    "Coding": [
                                                        {
                                                            "System": "",
                                                            "Code": "",
                                                            "Display": ""
                                                        }
                                                    ],
                                                    "Text": ""
                                                },
                                                "Frequency": {
                                                    "Coding": [
                                                        {
                                                            "System": "",
                                                            "Code": "",
                                                            "Display": ""
                                                        }
                                                    ],
                                                    "Text": ""
                                                },
                                                "Duration": 1,
                                                "DurationUnit": {
                                                    "Coding": [
                                                        {
                                                            "System": "",
                                                            "Code": "",
                                                            "Display": ""
                                                        }
                                                    ],
                                                    "Text": ""
                                                },
                                                "AsNeeded": true
                                            }
                                        ],
                                        "PatientInstruction": "",
                                        "Quantity": 1,
                                        "QuantityUnit": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Route": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "RateRatioAmount": 1,
                                        "RateRatioTime": 1,
                                        "RateRatioTimeUnit": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "NumberOfRepeatsAllowed": 1,
                                        "SubstitutionsAllowed": true,
                                        "LastDispenseInClinic": {
                                            "Date": "",
                                            "Precision": "Year"
                                        }
                                    }
                                ],
                                "InactiveAllergies": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Category": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Substance": "",
                                        "SubstanceCode": [
                                            {
                                                "System": "",
                                                "Code": "",
                                                "Display": ""
                                            }
                                        ],
                                        "Reaction": "",
                                        "ReactionType": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Certainty": "mild",
                                        "Date": "",
                                        "DateFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "ClinicalStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "VerificationStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Notes": ""
                                    }
                                ],
                                "InactiveProblems": [
                                    {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "Name": "",
                                        "Code": [
                                            {
                                                "System": "",
                                                "Code": "",
                                                "Display": ""
                                            }
                                        ],
                                        "Category": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "ClinicalStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "ConfirmationStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "PersistenceStatus": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Severity": {
                                            "Coding": [
                                                {
                                                    "System": "",
                                                    "Code": "",
                                                    "Display": ""
                                                }
                                            ],
                                            "Text": ""
                                        },
                                        "Date": "",
                                        "DateFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "DateDescription": "",
                                        "Notes": "",
                                        "DateOfOnset": "",
                                        "DateOfOnsetFD": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "DateOfAbatement": {
                                            "Date": "",
                                            "Precision": "Year"
                                        },
                                        "Outcome": ""
                                    }
                                ]
                            },
                            "JournalItems": [
                                {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "NewEventDate": {
                                        "Date": "",
                                        "Precision": "Year"
                                    },
                                    "EventDate": "",
                                    "CreatedDate": "",
                                    "CreatedBy": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    },
                                    "LastModifiedDate": "",
                                    "LastModifiedBy": {
                                        "Id": "",
                                        "Descriptor": "",
                                        "Metadata": {
                                            "Type": "",
                                            "Path": ""
                                        },
                                        "Assigner": "",
                                        "ReferenceType": ""
                                    }
                                }
                            ],
                            "CareTeam": {
                                "CareTeamProvider": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "PrimaryProvider": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "AlternateProvider": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "Pharmacy": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "FamilyMD": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                },
                                "Location": {
                                    "Id": "",
                                    "Descriptor": "",
                                    "Metadata": {
                                        "Type": "",
                                        "Path": ""
                                    },
                                    "Assigner": "",
                                    "ReferenceType": ""
                                }
                            },
                            "OtherInfo": {
                                "BillingProvince": "AB",
                                "Notes": "",
                                "ChartId": "",
                                "Rostered": true,
                                "RosteredDate": {
                                    "Date": "",
                                    "Precision": "Year"
                                }
                            },
                            "Active": true
                        },
                        "Reason": "",
                        "Problem": "",
                        "SignedOut": true,
                        "StartDate": "",
                        "EndDate": "",
                        "Notes": "",
                        "Status": "",
                        "ScheduleLocation": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "ReferenceType": ""
                        },
                        "BookingHistory": {
                            "BookedDate": "",
                            "BookedBy": "",
                            "ChangedDate": "",
                            "ChangedBy": ""
                        },
                        "Cancelled": true,
                        "AppointmentType": {
                            "Id": "",
                            "Descriptor": "",
                            "Metadata": {
                                "Type": "",
                                "Path": ""
                            },
                            "Assigner": "",
                            "BackgroundColour": "",
                            "ForegroundColour": "",
                            "DefaultText": "",
                            "DefaultDurationInMinutes": 1
                        },
                        "Deleted": true
                    }
                ]
            }
        ]
    }
}
Operations
appointments

Operations for appointments

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

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

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

AppointmentId
string optional

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

ProviderId
string optional

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

PatientId
string optional

ID of patient’s encounters to search for

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

SearchBackwards
boolean optional

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

IncludeDeleted
boolean optional

If true it will make sure deleted items are also returned

Type
string optional

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

Request headers

If-Modified-Since
string date optional

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

Responses

200 OK

Returns the appointments.

appointmenttypes

Operations for appointment types

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

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

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

AppointmentTypeId
string optional

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

Request headers

If-Modified-Since
string date optional

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

Responses

200 OK

Returns the appointment types.

capabilities

Operations for capabilities

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

Returns the current capabilities of the EMR

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

Responses

200 OK

Returns the capabilities of the EMR.

consultants

Operations for consultants

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

Returns the list of consultants

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

ConsultantId
string optional

Specific consultant to search for, all other parameters ignored

SearchString
string optional

String to use for searching

Responses

200 OK

Returns the consultants.

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

Add a new consultant

Supported by:

  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

Responses

200 OK

Returns the consultants.

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

Update a specific consultant

Supported by:

  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

Responses

200 OK

Returns the consultants.

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

Returns the list of consultants

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ConsultantId
string required

Specific consultant to search for, all other parameters ignored

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

Responses

200 OK

Returns the consultants.

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

Remove a consultant by ID

Supported by:

  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ConsultantId
string required

ID of the consultant to remove

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Responses

200 OK

Returns the consultants.

encounters

Operations for encounters

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

Returns the list of encounters

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

EncounterId
string optional

ID of the encounter

PatientId
string optional

ID of the patient

DetailLevel
string optional

Detail level of the encounter

Request headers

If-Modified-Since
string date optional

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

Responses

200 OK

Returns encounters

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

Returns the list of encounters

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
EncounterId
string required

ID of the encounter

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

PatientId
string optional

ID of the patient

DetailLevel
string optional

Detail level of the encounter

Responses

200 OK

Returns encounters

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

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

The HTML that is sent can only contain whitelisted tags:

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

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

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

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Patient ID to add encounter to

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Request body

multipart/form-data
Object
html
string

HTML formatted richtext. Send as text/html

encounter
string

Send as an application/json with an EncounterCreateRequest

Responses

200 OK

Return the encounter ID of the created encounter

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

Adds a new encounter

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Patient ID to add encounter to

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Request body

Responses

200 OK

Return the encounter ID of the created encounter

facilities

Operations for facilities

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

Returns the list of facilities

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

FacilityId
string optional

ID of the facility

SearchString
string optional

String to use for searching

Responses

200 OK

Return facilities

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

Returns the list of facilities

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
FacilityId
string required

ID of the facility

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

Responses

200 OK

Return facilities

patients

Operations for patients

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

Returns the list of patients

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

PatientId
string optional
SearchString
string optional

String to use for searching

DetailLevel
string optional
IncludingHistory
boolean optional

Responses

200 OK

Return patients

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

Returns the specific patient

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

DetailLevel
string optional
IncludingHistory
boolean optional

Responses

200 OK

Return patient

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

Returns the specific patient with specific detail level

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

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

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

IncludingHistory
boolean optional

Responses

200 OK

Return patient

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

Update an existing patient's demographics

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Patient ID

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Request body

Responses

200 OK

Return the patient ID of the updated patient

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

Update an existing patient's demographics using a patch

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
PatientId
string required

Patient ID

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Responses

200 OK

Return the patient ID of the patched patient

linked documents

Operations for linked documents

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

Returns the list of linked documents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

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

String to use for searching

Responses

200 OK

Return linked documents

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

Add a new linked document

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

Responses

200 OK

Successful upload of linked document

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

Returns the specific linked document

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
LinkedDocumentId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

ProviderId
string optional
PatientId
string optional
SearchString
string optional

String to use for searching

Responses

200 OK

Return linked document

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

Returns the linked document contents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
LinkedDocumentId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

PatientId
string optional
EncounterId
string optional
Thumbnail
boolean optional

Responses

200 OK

Return linked documents

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

Returns the linked document contents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
LinkedDocumentId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

PatientId
string optional
EncounterId
string optional
Thumbnail
boolean optional

Responses

200 OK

Return linked documents

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

Returns the linked document contents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

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

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Thumbnail
boolean optional

Responses

200 OK

Return linked documents

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

Returns the linked document contents

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

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

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Thumbnail
boolean optional

Responses

200 OK

Return linked documents

providers

Operations for providers

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

Returns the list of providers

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

SearchString
string optional

String to use for searching

Responses

200 OK

Return providers

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

Returns the specific provider

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ProviderId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Responses

200 OK

Return provider

schedules

Operations for schedules

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

Returns the list of schedules

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

SearchString
string optional

String to use for searching

Responses

200 OK

Return schedules

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

Returns the list of schedules

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Responses

200 OK

Return schedules

404 404

Not found

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

Returns the list of schedules

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

NumberOfRecords
integer optional

Numbers of records per-page to return.

Default:
40
StartAtRecord
integer optional

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

Default:
0
IncludeTotal
boolean optional

Return total number of records

StartDate
string date optional

Start date for limiting range of results to be returned

EndDate
string date optional

End date for limiting range of results to be returned

IncludeDeleted
boolean optional

If true it will make sure deleted items are also returned

Request headers

If-Modified-Since
string date optional

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

Responses

200 OK

Return schedule appointments

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

Create a new appointment

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Responses

200 OK

Return the appointment ID of the created appointment

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

Update an existing appointment

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

AppointmentId
string required

Appointment ID

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Responses

200 OK

Return the appointment ID of the updated appointment

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

Update an existing appointment using a patch

Supported by:

  • PS Suite

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Schedule ID

AppointmentId
string required

Appointment ID

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Responses

200 OK

Return the appointment ID of the updated appointment

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

Returns the list of schedulables

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Date
string date optional

Responses

200 OK

Return schedulables

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

Returns the list of schedules summaries

Supported by:

  • KinLogix
  • PS Suite
  • Wolf

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

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

Date
string date optional

Responses

200 OK

Return schedule summaries

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

Add a schedule summary

Currently not supported

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

Request body

Responses

200 OK

Successful add

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

Update a schedule summary

Currently not supported

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

Request body

Responses

200 OK

Successful update

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

Remove a scheudle summary

Currently not supported

Path variables

EmrType
string required
InstanceId
string required
ScheduleId
string required

Request parameters

AppToken
string required

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

Language
string optional

Preferred language

Version
string optional

Version of API to use

TutorialData
boolean optional

Used to request tutorial data

ActivityId
string optional

Used for logging

EmrType
string required

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

Enumeration:
PSS

PS Suite

MA

Med Access

Wolf

Wolf

Kin

Kinlogix

Medesync

Medesync

InstanceId
string required

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

UserToken
string required

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

EmrSessionToken
string required

Identifies a short-lived authentication session during which a client ho