PatientEndpoint Resource

This PatientEndpoint collection is designed to expose the Patient DTO and related public endpoints. Requires provider level authorization.

See Also
ProviderEnrollmentTerminationReason

POST /v1/provider-portal/patients

Create a new patient.

See Also
ProviderEnrollmentTerminationReason
Request Parameters
name type description
Authorization header Provider level authorization grant
Request Body
media type data type description
application/json PatientDto (JSON) JSON representation of the patient fields
Response Codes
code condition
400 invalid enrolledProviderId
400 enroll provider when the module, Patient Enrollment, is off
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json object (JSON) Response with the patient ID and location of the newly created resource.

Example

Request
POST /v1/provider-portal/patients
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "patientId" : 1,
  "demographics" : {
    "firstName" : "John",
    "lastName" : "Doe",
    "middleName" : "Smith",
    "title" : "Mr.",
    "suffix" : "Sr.",
    "birthday" : "1959-02-16T00:00:00.000-0800",
    "genderId" : 1,
    "email" : {
      "emailId" : 1,
      "type" : "Business",
      "address" : "contact@doctor.com",
      "order" : 1
    },
    "phones" : [ {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    }, {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    } ],
    "addresses" : [ {
      "street" : "102 Maple Street",
      "city" : "Vancouver",
      "postalZip" : "A1A2B2",
      "locationId" : 1,
      "note" : "A quick note.",
      "type" : "type",
      "start" : 2017,
      "end" : 2017,
      "masks" : [ { }, { } ]
    }, {
      "street" : "102 Maple Street",
      "city" : "Vancouver",
      "postalZip" : "A1A2B2",
      "locationId" : 1,
      "note" : "A quick note.",
      "type" : "type",
      "start" : 2017,
      "end" : 2017,
      "masks" : [ { }, { } ]
    } ],
    "healthCard" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    },
    "preferredContactType" : "WorkPhone",
    "nextKinName" : "Jane Doe",
    "nextKinPhone" : {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    },
    "officialLanguageCode" : "eng",
    "spokenLanguageCode" : "bul",
    "relationshipStatusId" : 2
  },
  "familyProviderId" : 1,
  "enrolledProviderId" : 1,
  "enrolledProvideTerminationReason" : "PATIENT_MOVED",
  "officeProviderId" : 1,
  "referringProviderId" : 1,
  "insurerId" : 1,
  "fileNumber" : "22-12345",
  "uuid" : "dca20596-e35e-325f-56a4-3190281a020f",
  "registrationNumber" : "123",
  "paperChartNote" : "A note",
  "paperChart" : true,
  "patientStatusId" : 1,
  "gestationAge" : "2017-11-08 00:00:00.000",
  "employerContactId" : 1,
  "pharmacyContactId" : 1,
  "referredDate" : "2017-11-08 00:00:00.000",
  "onSocialAssistance" : true,
  "hasArchivedRecords" : true,
  "deceased" : true,
  "deceasedDate" : "2017-11-08 00:00:00.000",
  "occupation" : "Nurse",
  "alert" : {
    "message" : "A message",
    "lastUpdated" : "2016-02-16T00:00:00.000-0800",
    "flagUser" : 12345
  },
  "albertaDetails" : {
    "type" : "RECP",
    "newBornCode" : "ADOP",
    "guardianUli" : "234-123-564",
    "guardianRegistration" : "123",
    "uli2" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    }
  },
  "ontarioDetails" : {
    "validationStatus" : true,
    "validationMessage" : "A message",
    "admissionDate" : "2000-05-31 00:00:00.000",
    "dischargeDate" : "2000-05-31 00:00:00.000",
    "masterNumber" : 123
  },
  "novaScotiaDetails" : {
    "guardianHcn" : "123-234-123",
    "secondaryHealthCard" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    },
    "lastUpdatedDatetime" : "2000-05-31 00:00:00.000"
  },
  "manitobaDetails" : {
    "healthRegistrationNumber" : "123"
  }
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/provider-portal/patients/search

Search for patients by personal health number/care card number.

Request Parameters
name type description
Authorization header Provider level authorization grant
phn query Start of personal health number being searched. This is a mandatory field.
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json array of PatientDto (JSON) List of patients matching the search. An empty list if the phn is not provided.

Example

Request
GET /v1/provider-portal/patients/search
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "patientId" : 1,
  "demographics" : {
    "firstName" : "John",
    "lastName" : "Doe",
    "middleName" : "Smith",
    "title" : "Mr.",
    "suffix" : "Sr.",
    "birthday" : "1959-02-16T00:00:00.000-0800",
    "genderId" : 1,
    "email" : {
      "emailId" : 1,
      "type" : "Business",
      "address" : "contact@doctor.com",
      "order" : 1
    },
    "phones" : [ {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    }, {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    } ],
    "addresses" : [ {
      "street" : "102 Maple Street",
      "city" : "Vancouver",
      "postalZip" : "A1A2B2",
      "locationId" : 1,
      "note" : "A quick note.",
      "type" : "type",
      "start" : 2017,
      "end" : 2017,
      "masks" : [ { }, { } ]
    }, {
      "street" : "102 Maple Street",
      "city" : "Vancouver",
      "postalZip" : "A1A2B2",
      "locationId" : 1,
      "note" : "A quick note.",
      "type" : "type",
      "start" : 2017,
      "end" : 2017,
      "masks" : [ { }, { } ]
    } ],
    "healthCard" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    },
    "preferredContactType" : "WorkPhone",
    "nextKinName" : "Jane Doe",
    "nextKinPhone" : {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    },
    "officialLanguageCode" : "eng",
    "spokenLanguageCode" : "bul",
    "relationshipStatusId" : 2
  },
  "familyProviderId" : 1,
  "enrolledProviderId" : 1,
  "enrolledProvideTerminationReason" : "PATIENT_MOVED",
  "officeProviderId" : 1,
  "referringProviderId" : 1,
  "insurerId" : 1,
  "fileNumber" : "22-12345",
  "uuid" : "dca20596-e35e-325f-56a4-3190281a020f",
  "registrationNumber" : "123",
  "paperChartNote" : "A note",
  "paperChart" : true,
  "patientStatusId" : 1,
  "gestationAge" : "2017-11-08 00:00:00.000",
  "employerContactId" : 1,
  "pharmacyContactId" : 1,
  "referredDate" : "2017-11-08 00:00:00.000",
  "onSocialAssistance" : true,
  "hasArchivedRecords" : true,
  "deceased" : true,
  "deceasedDate" : "2017-11-08 00:00:00.000",
  "occupation" : "Nurse",
  "alert" : {
    "message" : "A message",
    "lastUpdated" : "2016-02-16T00:00:00.000-0800",
    "flagUser" : 12345
  },
  "albertaDetails" : {
    "type" : "RECP",
    "newBornCode" : "ADOP",
    "guardianUli" : "234-123-564",
    "guardianRegistration" : "123",
    "uli2" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    }
  },
  "ontarioDetails" : {
    "validationStatus" : true,
    "validationMessage" : "A message",
    "admissionDate" : "2000-05-31 00:00:00.000",
    "dischargeDate" : "2000-05-31 00:00:00.000",
    "masterNumber" : 123
  },
  "novaScotiaDetails" : {
    "guardianHcn" : "123-234-123",
    "secondaryHealthCard" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    },
    "lastUpdatedDatetime" : "2000-05-31 00:00:00.000"
  },
  "manitobaDetails" : {
    "healthRegistrationNumber" : "123"
  }
} ]

GET /v1/provider-portal/patients/{patientId}

Return the patient associated with this patient ID

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Response Codes
code condition
404 If the patient records does not exist in the database.
404 If the patient records does not exist in the database.
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json PatientDto (JSON) Patient associated with this patient ID

Example

Request
GET /v1/provider-portal/patients/{patientId}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "patientId" : 1,
  "demographics" : {
    "firstName" : "John",
    "lastName" : "Doe",
    "middleName" : "Smith",
    "title" : "Mr.",
    "suffix" : "Sr.",
    "birthday" : "1959-02-16T00:00:00.000-0800",
    "genderId" : 1,
    "email" : {
      "emailId" : 1,
      "type" : "Business",
      "address" : "contact@doctor.com",
      "order" : 1
    },
    "phones" : [ {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    }, {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    } ],
    "addresses" : [ {
      "street" : "102 Maple Street",
      "city" : "Vancouver",
      "postalZip" : "A1A2B2",
      "locationId" : 1,
      "note" : "A quick note.",
      "type" : "type",
      "start" : 2017,
      "end" : 2017,
      "masks" : [ { }, { } ]
    }, {
      "street" : "102 Maple Street",
      "city" : "Vancouver",
      "postalZip" : "A1A2B2",
      "locationId" : 1,
      "note" : "A quick note.",
      "type" : "type",
      "start" : 2017,
      "end" : 2017,
      "masks" : [ { }, { } ]
    } ],
    "healthCard" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    },
    "preferredContactType" : "WorkPhone",
    "nextKinName" : "Jane Doe",
    "nextKinPhone" : {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    },
    "officialLanguageCode" : "eng",
    "spokenLanguageCode" : "bul",
    "relationshipStatusId" : 2
  },
  "familyProviderId" : 1,
  "enrolledProviderId" : 1,
  "enrolledProvideTerminationReason" : "PATIENT_MOVED",
  "officeProviderId" : 1,
  "referringProviderId" : 1,
  "insurerId" : 1,
  "fileNumber" : "22-12345",
  "uuid" : "dca20596-e35e-325f-56a4-3190281a020f",
  "registrationNumber" : "123",
  "paperChartNote" : "A note",
  "paperChart" : true,
  "patientStatusId" : 1,
  "gestationAge" : "2017-11-08 00:00:00.000",
  "employerContactId" : 1,
  "pharmacyContactId" : 1,
  "referredDate" : "2017-11-08 00:00:00.000",
  "onSocialAssistance" : true,
  "hasArchivedRecords" : true,
  "deceased" : true,
  "deceasedDate" : "2017-11-08 00:00:00.000",
  "occupation" : "Nurse",
  "alert" : {
    "message" : "A message",
    "lastUpdated" : "2016-02-16T00:00:00.000-0800",
    "flagUser" : 12345
  },
  "albertaDetails" : {
    "type" : "RECP",
    "newBornCode" : "ADOP",
    "guardianUli" : "234-123-564",
    "guardianRegistration" : "123",
    "uli2" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    }
  },
  "ontarioDetails" : {
    "validationStatus" : true,
    "validationMessage" : "A message",
    "admissionDate" : "2000-05-31 00:00:00.000",
    "dischargeDate" : "2000-05-31 00:00:00.000",
    "masterNumber" : 123
  },
  "novaScotiaDetails" : {
    "guardianHcn" : "123-234-123",
    "secondaryHealthCard" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    },
    "lastUpdatedDatetime" : "2000-05-31 00:00:00.000"
  },
  "manitobaDetails" : {
    "healthRegistrationNumber" : "123"
  }
}
See Also
ProviderEnrollmentTerminationReason

PATCH /v1/provider-portal/patients/{patientId}

Update a patient. This endpoint allows partial update, i.e., update only those fields which need to be updated instead of updating entire Patient object. If there are any invalid fields in the request, they will be ignored and the valid ones will be updated.

See Also
ProviderEnrollmentTerminationReason
Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/merge-patch+json JsonMergePatch (JSON) JSON representation of the patient fields which need to be updated or modified. In other words it is a patient object which includes only those fields which need to be updated. For example, if we are changing only suffix and email of the object, JSON representation would be like: { "demographics": { "suffix": "suffix", "email": { "address": "test@email.com" } } }
Response Codes
code condition
400 patient information missing
400 location id missing on the non primary or secondary address
400 patient does not exit with the ID provided
400 the termination reason is not valid in the current province
400 invalid enrolledProviderId
400 update enrolled provider when the module Patient Enrollment is off
400 update enrolled provider in a invalid way. Please refer to the documentation for the enrolledProviderId field under PatientDto object.
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json object (JSON) Response with status 204 if the patient's information was updated successfully

Example

Request
PATCH /v1/provider-portal/patients/{patientId}
Content-Type: application/merge-patch+json
Accept: application/json
Authorization: ...

                
{ }
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
See Also
ProviderEnrollmentTerminationReason

PUT /v1/provider-portal/patients/{patientId}

Update a patient.

See Also
ProviderEnrollmentTerminationReason
Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json PatientDto (JSON) JSON representation of the patient fields
Response Codes
code condition
400 patient information missing
400 location id missing on the non primary or secondary address
400 patient does not exit with the ID provided
400 the termination reason is not valid in the current province
400 invalid enrolledProviderId
400 update enrolled provider when the module, Patient Enrollment, is off
400 update enrolled provider in the invalid ways. Please refer to the documentation for the enrolledProviderId field under PatientDto object.
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's information was updated successfully

Example

Request
PUT /v1/provider-portal/patients/{patientId}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "patientId" : 1,
  "demographics" : {
    "firstName" : "John",
    "lastName" : "Doe",
    "middleName" : "Smith",
    "title" : "Mr.",
    "suffix" : "Sr.",
    "birthday" : "1959-02-16T00:00:00.000-0800",
    "genderId" : 1,
    "email" : {
      "emailId" : 1,
      "type" : "Business",
      "address" : "contact@doctor.com",
      "order" : 1
    },
    "phones" : [ {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    }, {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    } ],
    "addresses" : [ {
      "street" : "102 Maple Street",
      "city" : "Vancouver",
      "postalZip" : "A1A2B2",
      "locationId" : 1,
      "note" : "A quick note.",
      "type" : "type",
      "start" : 2017,
      "end" : 2017,
      "masks" : [ { }, { } ]
    }, {
      "street" : "102 Maple Street",
      "city" : "Vancouver",
      "postalZip" : "A1A2B2",
      "locationId" : 1,
      "note" : "A quick note.",
      "type" : "type",
      "start" : 2017,
      "end" : 2017,
      "masks" : [ { }, { } ]
    } ],
    "healthCard" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    },
    "preferredContactType" : "WorkPhone",
    "nextKinName" : "Jane Doe",
    "nextKinPhone" : {
      "phoneId" : 1,
      "number" : "(123) 456-7890",
      "ext" : "112",
      "equipType" : "Cell",
      "usage" : "Active",
      "notes" : "Only available between 8am and noon.",
      "order" : 2,
      "contactType" : "Business"
    },
    "officialLanguageCode" : "eng",
    "spokenLanguageCode" : "bul",
    "relationshipStatusId" : 2
  },
  "familyProviderId" : 1,
  "enrolledProviderId" : 1,
  "enrolledProvideTerminationReason" : "PATIENT_MOVED",
  "officeProviderId" : 1,
  "referringProviderId" : 1,
  "insurerId" : 1,
  "fileNumber" : "22-12345",
  "uuid" : "dca20596-e35e-325f-56a4-3190281a020f",
  "registrationNumber" : "123",
  "paperChartNote" : "A note",
  "paperChart" : true,
  "patientStatusId" : 1,
  "gestationAge" : "2017-11-08 00:00:00.000",
  "employerContactId" : 1,
  "pharmacyContactId" : 1,
  "referredDate" : "2017-11-08 00:00:00.000",
  "onSocialAssistance" : true,
  "hasArchivedRecords" : true,
  "deceased" : true,
  "deceasedDate" : "2017-11-08 00:00:00.000",
  "occupation" : "Nurse",
  "alert" : {
    "message" : "A message",
    "lastUpdated" : "2016-02-16T00:00:00.000-0800",
    "flagUser" : 12345
  },
  "albertaDetails" : {
    "type" : "RECP",
    "newBornCode" : "ADOP",
    "guardianUli" : "234-123-564",
    "guardianRegistration" : "123",
    "uli2" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    }
  },
  "ontarioDetails" : {
    "validationStatus" : true,
    "validationMessage" : "A message",
    "admissionDate" : "2000-05-31 00:00:00.000",
    "dischargeDate" : "2000-05-31 00:00:00.000",
    "masterNumber" : 123
  },
  "novaScotiaDetails" : {
    "guardianHcn" : "123-234-123",
    "secondaryHealthCard" : {
      "phn" : "1254",
      "locationId" : 1,
      "expiry" : "2016-02-16T00:00:00.000-0800"
    },
    "lastUpdatedDatetime" : "2000-05-31 00:00:00.000"
  },
  "manitobaDetails" : {
    "healthRegistrationNumber" : "123"
  }
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

DELETE /v1/provider-portal/patients/{patientId}/aliases

Delete a Patient's Aliases.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
aliasId query Alias ID int
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's alias was delete successfully

Example

Request
DELETE /v1/provider-portal/patients/{patientId}/aliases
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/provider-portal/patients/{patientId}/aliases

Retrieve a list of patients aliases.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json array of AliasDto (JSON) List of Patient's Aliases

Example

Request
GET /v1/provider-portal/patients/{patientId}/aliases
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "aliasId" : 1,
  "firstName" : "Jonathan",
  "lastName" : "Doe",
  "aliasType" : "AliasType"
} ]

POST /v1/provider-portal/patients/{patientId}/aliases

Add a new patient alias.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json AliasDto (JSON) Alias
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json number (JSON) Alias's ID if successful

Example

Request
POST /v1/provider-portal/patients/{patientId}/aliases
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "aliasId" : 1,
  "firstName" : "Jonathan",
  "lastName" : "Doe",
  "aliasType" : "AliasType"
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /v1/provider-portal/patients/{patientId}/aliases

Update a patient alias.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json AliasDto (JSON) Alias
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's alias was updated successfully

Example

Request
PUT /v1/provider-portal/patients/{patientId}/aliases
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "aliasId" : 1,
  "firstName" : "Jonathan",
  "lastName" : "Doe",
  "aliasType" : "AliasType"
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/provider-portal/patients/{patientId}/custom-properties

Retrieve Patient's Custom Properties.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
officeId query int
Response Codes
code condition
200 Success
400 Invalid patient Id or requires specific user
403 Forbidden
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json map of string (JSON) Map of Property Name to Value

Example

Request
GET /v1/provider-portal/patients/{patientId}/custom-properties
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PATCH /v1/provider-portal/patients/{patientId}/custom-properties

Merges updated patient's custom properties map to the existing custom properties map. In order to remove custom property, set its value to null in the request.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/merge-patch+json map of string (JSON) Map of Custom Properties key-value pairs which needs to merged into the existing Map.
Response Codes
code condition
200 Success
400 Invalid patient Id or requires specific user
403 Forbidden
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's custom properties were updated successfully

Example

Request
PATCH /v1/provider-portal/patients/{patientId}/custom-properties
Content-Type: application/merge-patch+json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /v1/provider-portal/patients/{patientId}/custom-properties

Update Patient's Custom Properties.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json map of string (JSON) Map property name to value
Response Codes
code condition
200 Success
400 Invalid patient Id or requires specific user
403 Forbidden
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's custom properties were updated successfully

Example

Request
PUT /v1/provider-portal/patients/{patientId}/custom-properties
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

DELETE /v1/provider-portal/patients/{patientId}/emails

Delete Patient's Email.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient Id int
emailId query Email Id int
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's email was deleted successfully

Example

Request
DELETE /v1/provider-portal/patients/{patientId}/emails
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/provider-portal/patients/{patientId}/emails

Retrieve a list the patients email address information.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json array of EmailDto (JSON) List of Patient's emails

Example

Request
GET /v1/provider-portal/patients/{patientId}/emails
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "emailId" : 1,
  "type" : "Business",
  "address" : "contact@doctor.com",
  "order" : 1
} ]

POST /v1/provider-portal/patients/{patientId}/emails

Create Patient's Email.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json EmailDto (JSON) Email.
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json number (JSON) New email ID

Example

Request
POST /v1/provider-portal/patients/{patientId}/emails
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "emailId" : 1,
  "type" : "Business",
  "address" : "contact@doctor.com",
  "order" : 1
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /v1/provider-portal/patients/{patientId}/emails

Update Patient's Email.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json EmailDto (JSON) Email object
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's email was updated successfully

Example

Request
PUT /v1/provider-portal/patients/{patientId}/emails
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "emailId" : 1,
  "type" : "Business",
  "address" : "contact@doctor.com",
  "order" : 1
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/provider-portal/patients/{patientId}/insurers

Retrieve a list of insurer ID's which are the private insurers for a specific patient.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json array of number (JSON) List of Patient's Private Insurer IDs

Example

Request
GET /v1/provider-portal/patients/{patientId}/insurers
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /v1/provider-portal/patients/{patientId}/insurers

Update a patients private insurers.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json array of number (JSON) List of insurer ID's
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's insurer information was updated successfully

Example

Request
PUT /v1/provider-portal/patients/{patientId}/insurers
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

DELETE /v1/provider-portal/patients/{patientId}/phones

Delete Patient's Phone.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
phoneId query Phone ID int
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's phone was deleted successfully

Example

Request
DELETE /v1/provider-portal/patients/{patientId}/phones
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/provider-portal/patients/{patientId}/phones

Retrieve list of patients phone.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json array of PhoneDto (JSON) List of Patient's Phones

Example

Request
GET /v1/provider-portal/patients/{patientId}/phones
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "phoneId" : 1,
  "number" : "(123) 456-7890",
  "ext" : "112",
  "equipType" : "Cell",
  "usage" : "Active",
  "notes" : "Only available between 8am and noon.",
  "order" : 2,
  "contactType" : "Business"
} ]

POST /v1/provider-portal/patients/{patientId}/phones

Create Patient's Phone.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json PhoneDto (JSON) Phone
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json number (JSON) Phone's ID if successful

Example

Request
POST /v1/provider-portal/patients/{patientId}/phones
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "phoneId" : 1,
  "number" : "(123) 456-7890",
  "ext" : "112",
  "equipType" : "Cell",
  "usage" : "Active",
  "notes" : "Only available between 8am and noon.",
  "order" : 2,
  "contactType" : "Business"
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /v1/provider-portal/patients/{patientId}/phones

Update a patients phone.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json PhoneDto (JSON) Phone
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's phone was updated successfully

Example

Request
PUT /v1/provider-portal/patients/{patientId}/phones
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "phoneId" : 1,
  "number" : "(123) 456-7890",
  "ext" : "112",
  "equipType" : "Cell",
  "usage" : "Active",
  "notes" : "Only available between 8am and noon.",
  "order" : 2,
  "contactType" : "Business"
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/provider-portal/patients/{patientId}/profile-picture

Retrieves byte data of the patient profile picture.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Unique patient id. required
Response Codes
code condition
400 if there are field or business validation errors.
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json object (JSON) byte data of patient profile picture

Example

Request
GET /v1/provider-portal/patients/{patientId}/profile-picture
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /v1/provider-portal/patients/{patientId}/profile-picture

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
image multipart required
patientId path required
Request Body
media type data type
multipart/form-data (custom)
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /v1/provider-portal/patients/{patientId}/profile-picture
Content-Type: multipart/form-data
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/provider-portal/patients/{patientId}/role-flags

Retrieve Patient's Role Flags.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json map of PatientFlagDto (JSON) Map of Role ID to Flag

Example

Request
GET /v1/provider-portal/patients/{patientId}/role-flags
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "..." : {
    "message" : "A message",
    "lastUpdated" : "2016-02-16T00:00:00.000-0800",
    "flagUser" : 12345
  }
}

PUT /v1/provider-portal/patients/{patientId}/role-flags

Update Patient's Role Flags.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json map of PatientFlagDto (JSON) Map of role ID to flag
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's role flags were updated successfully

Example

Request
PUT /v1/provider-portal/patients/{patientId}/role-flags
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "..." : {
    "message" : "A message",
    "lastUpdated" : "2016-02-16T00:00:00.000-0800",
    "flagUser" : 12345
  }
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/provider-portal/patients/{patientId}/user-flags

Retrieve Patient's User Flags.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json map of PatientFlagDto (JSON) Map of User ID to Flag

Example

Request
GET /v1/provider-portal/patients/{patientId}/user-flags
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "..." : {
    "message" : "A message",
    "lastUpdated" : "2016-02-16T00:00:00.000-0800",
    "flagUser" : 12345
  }
}

PUT /v1/provider-portal/patients/{patientId}/user-flags

Update Patient's User Flags.

Request Parameters
name type description constraints
Authorization header Provider level authorization grant  
patientId path Patient ID int
Request Body
media type data type description
application/json map of PatientFlagDto (JSON) Map of Accuro user ID to flag
Response Codes
code condition
200 Request successful
401 Consumer unauthorized
Response Body
media type data type description
application/json boolean (JSON) true if the patient's user flags were updated successfully

Example

Request
PUT /v1/provider-portal/patients/{patientId}/user-flags
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "..." : {
    "message" : "A message",
    "lastUpdated" : "2016-02-16T00:00:00.000-0800",
    "flagUser" : 12345
  }
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...