The Patient model object
| name | data type | constraints | description |
|---|---|---|---|
| patientId | number | required | A unique Patient ID. |
| demographics | DemographicsDto | A Demographic DTO for the Patient | |
| familyProviderId | number | The ID of the patients family Provider. | |
| enrolledProviderId | number | The ID of the patients enrolled Provider.
While updating enrolledProviderId field, do consider these points:
|
|
| enrolledProvideTerminationReason | ProviderEnrollmentTerminationReason | Termination reason of the enrolled provider. This field is enum and should have values which are part of ProviderEnrollmentTerminationReason. This field is relevant only during update patient request. During GET patient requests, this field remains null. | |
| officeProviderId | number | The ID of the patients office Provider | |
| referringProviderId | number | The ID of the patients referring Provider. | |
| insurerId | number | The ID for the patients Insurer. | |
| fileNumber | string | The patients File Number | |
| uuid | string | The patients UUID Number. This parameter is read only. | |
| registrationNumber | string | The patient Registration Number | |
| paperChartNote | string | A note for the patients paper chart. | |
| paperChart | boolean | required | Indication if the patient has a paper chart. |
| patientStatusId | number | The patients Status ID | |
| gestationAge | string | The patients gestation age | |
| employerContactId | number | The employer contact ID | |
| pharmacyContactId | number | The pharmacy contact ID | |
| referredDate | string | Patient referred date | |
| onSocialAssistance | boolean | required | Indication if the patient is on social assistance. |
| hasArchivedRecords | boolean | required | Indication if the patient has archived records. |
| deceased | boolean | required | Indication if the patient is deceased. |
| deceasedDate | string | Patient deceased date. | |
| occupation | string | Patient occupation | |
| alert | PatientFlagDto | Patient alert flag | |
| albertaDetails | AlbertaDetailsDto | Alberta specific details | |
| ontarioDetails | OntarioDetailsDto | Ontario specific details | |
| novaScotiaDetails | NovaScotiaDetailsDto | Nova Scotia specific details | |
| manitobaDetails | ManitobaDetailsDto | Manitoba specific details |
Example
{
"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"
}
}