170.315(g)(8)(A) Data Category Request
Endpoints: Get a patient details by PatientId
GET: {BaseUrl}/api/v1/patients/{id}/slim
| Name | Data Type | Description | Required | Route |
| Id |
GUID |
Patient Identifier | Yes |
Path |
| X-Time-Zone |
String | DTime Zone of the agency, Ex: America/Chicago | Yes |
Header |
| Authorization | String | Identity token | Yes | Header |
| X-Account-Id | GUID | Account identifier | Yes | Header |
Response:
{
"id": "00000000-0000-0000-0000-000000000000",
"branchId": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string",
"middleInitial": "string",
"latestAdmissionId": "00000000-0000-0000-0000-000000000000",
"suffix": "string",
"medicalRecordNumber": "string",
"gender": 1,
"dateOfBirth": "2021-11-29T17:11:47.872Z",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"statusReason": "string",
"longitude": 0,
"latitude": 0,
"preferredPhone": "string",
"medicareNumber": "string",
"medicareBeneficiaryIdentification": "string",
"medicaidNumber": "string",
"benefitPeriodStartDate": "2021-11-29T17:11:47.872Z",
"transferBenefitPeriodStartDate": "2021-11-29T17:11:47.872Z",
"isTransfer": true,
"benefitPeriodEndDate": "2021-11-29T17:11:47.872Z",
"funeralHomeName": "string",
"funeralHomePhoneNumber": "string",
"primaryPayorName": "string",
"levelOfCare": 1,
"lineOfService": 0,
"veterans": [
0
],
"isDoNotResuscitate": true,
"isReAdmit": true,
"referralId": "00000000-0000-0000-0000-000000000000",
"referralDate": "2021-11-29T17:11:47.872Z",
"status": 0,
"assetId": "00000000-0000-0000-0000-000000000000",
"diagnoses": [
{
"code": "string",
"order": 0,
"startDate": "2021-11-29T17:11:47.872Z",
"resolvedDate": "2021-11-29T17:11:47.872Z",
"isRelated": true,
"notRelatedComments": "string"
}
],
"attendingPhysicianId": "00000000-0000-0000-0000-000000000000",
"attendingPhysicianName": "string",
"admissionDate": "2021-11-29T17:11:47.872Z",
"showAuthorizations": true,
"isHospitalized": true,
{
"name": "string"
],
"pendingReason": 0,
"pendingReasonComment": "string"
}
Endpoints: Get Vitalsigns of a Patient.
GET: {BaseUrl}/api/v1/vitalsign
| Name | Data Type | Description | Required | Route |
| PatientId | GUID | Patient Identifier | yes | URI |
| StartDate | DateTime | Start Date Range of vital signs | Yes | URI |
| EndDate | DateTime | End Date Range of vital signs | Yes | URI |
| Page | Int | Page number | Yes | URI |
| Page Length | Int | Page length | Yes | URI |
| X-Time-Zone | String | Time Zone of the agency Ex: America/Chicago | Yes | Header |
| Authorization | String | Identity token | Yes | Header |
| X-Account-Id | GUID | Account identifier | Yes | Header |
"itemCount": 0,
"pageLength": 0,
"currentPage": 0,
"pageCount": 0,
"items": [
{
"id": "00000000-0000-0000-0000-000000000000",
"scheduledDate": "2021-11-29T17:11:50.841Z",
"enteredBy": "string",
"taskName": "string",
"systolicPressure": 0,
"diastolicPressure": 0,
"temperature": 0,
"respiration": 0,
"oxygenSaturation": 0,
"pulseRate": 0,
"pulseLocation": 1,
"bloodPressurePosition": 1,
"temperatureRoute": 1,
"fahrenheitOrCelsius": 1,
"oxygenMethod": 1,
"unableToObtainBP": true,
"unableToObtainPulse": true
}
]
}
Endpoints: Get Problem Statements, Goals and Interventions of a patient
GET: {BaseUrl}/api/v1/poc/{patientId} Parameter:
| Name | Data Type | Description | Required | Route |
| PatientId |
GUID |
Patient Identifier | Yes |
Path |
| X-Time-Zone |
String | Time Zone of the agency, Ex: America/Chicago | Yes |
Header |
| Authorization | String | Identity token | Yes | Header |
| X-Account-Id | GUID | Account identifier | Yes | Header |
Response:
[
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"statements": [
"areaId": "00000000-0000-0000-0000-000000000000",
"problemId": "00000000-0000-0000-0000-000000000000",
"documentId": "00000000-0000-0000-0000-000000000000",
"statement": "string",
"effectiveDate": "2021-11-29T17:11:48.463Z",
"goals": [
"goal": "string",
"problemId": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string",
"userId": "00000000-0000-0000-0000-000000000000",
"completedBy": 1,
"effectiveDate": "2021-11-29T17:11:48.463Z"
"intervention": "string",
"problemId": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string",
"userId": "00000000-0000-0000-0000-000000000000",
"disciplines": [
0
],
"effectiveDate": "2021-11-29T17:11:48.463Z"
"userId": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string"
Endpoints: Get Patient Medications
GET: {BaseUrl}/api/v1/medications
Parameters:
| Name | Data Type | Description | Required | Route |
| PatientId |
GUID |
Patient Identifier | Yes |
URI |
| X-Time-Zone |
String | Time Zone of the agency, Ex: America/Chicago | Yes |
Header |
| Authorization | String | Identity token | Yes | Header |
| X-Account-Id | GUID | Account identifier | Yes | Header |
| Order | String | Order by asc, ascending, desc, descending | No | URI |
| SortBy | String | Sort by the columns MedicationName, Indication, StartDate, AdministeredBy, AddedByPhysician | No | URI |
"lexiDrugId": "string",
"customMedicationId": "00000000-0000-0000-0000-000000000000",
"startDate": "2021-11-29T17:11:47.021Z",
"medicationName": "string",
"frequency": "string",
"medicationFrequencyId": "00000000-0000-0000-0000-000000000000",
"isPrn": true,
"instructions": "string",
"dosage": "string",
"route": "string",
"classification": "string",
"discontinueDate": "2021-11-29T17:11:47.021Z",
"initialPhysicianId": "00000000-0000-0000-0000-000000000000",
"discontinuedPhysicianId": "00000000-0000-0000-0000-000000000000",
"addedByPhysician": "string",
"discontinuedByPhysician": "string",
"administeredBy": [
"indication": "string",
"isCovered": true,
"initialOrderId": "00000000-0000-0000-0000-000000000000",
"discontinueOrderId": "00000000-0000-0000-0000-000000000000",
"dispenseCount": 0,
"dispenseCount": 0,
dispenseCount": 0, "id": "00000000-0000-0000-0000-000000000000",
lastName": "string"
"discontinuedBy": {
"firstName": "string",
"lastName": "string"
"notRelatedComments": "string",
"isFromOrderSet": true
Endpoints: Get patient allergies
GET: {BaseUri}/api/v1/allergies
Parameters:
| Name | Data Type | Description | Required | Route |
| PatientId |
GUID |
Patient Identifier | Yes |
URI |
| X-Time-Zone |
String | Time Zone of the agency, Ex: America/Chicago | Yes |
Header |
| Authorization | String | Identity token | Yes | Header |
| X-Account-Id | GUID | Account identifier | Yes | Header |
| AllergyType | Enum | Use the Enum name in the Enum controller endpoint to get the values of the Enum Use value of the Enum for the request | No | URI |
Response:
"patientId": "00000000-0000-0000-0000-000000000000",
"allergy": "string",
"reaction": "string",
"type": 1,
"otherTypeDescription": "string",
"severity": 1,
"comments": "string",
"informationSource": "string",
"discontinuedById": "00000000-0000-0000-0000-000000000000",
"startDate": "2021-11-29T22:17:21.809Z",
"endDate": "2021-11-29T22:17:21.809Z",
"lexiDrugId": "string",
"synonymId": 0,
"customMedicationId": "00000000-0000-0000-0000-000000000000"