Swagger UIswagger

ReLi Med Solutions Portal Api
 v1

/swagger/v1/swagger.json

Account

GET/api/v1/accounts/myAccount
Returns the account information for the supplied token.

Parameters

No parameters

Responses

CodeDescription
200

The operation was successful. Returns an AccountModel that contains a summary view of the user’s account information.

#/definitions/AccountModelAccountModel{
description:

Contains a summary view of the user’s account information.
AccountTypestring
example: AuthenticationAccountType : 2 (Portal)
Describes how this account is authenticated.
Enum:
Array [ 4 ]
AccountUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique account identifier that represents the user.
PracticeSynonymstring
example: string : "CCC453"
A synonym used to identify the practice that this account is associated with.
CustomerPracticeUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier that represents the practice.
Emailstring
example: string : "john.smith@relimedsolutions.com"
The email address associated with the account.
FirstNamestring
example: string : "John"
The first name of the user that is associated with this account.
LastNamestring
example: string : "Smith"
The last name of the user that is associated with this account.
LoginNamestring
example: string : "john.smith@relimedsolutions.com"
The login name used to access the account. This is usually the same as the Email.
DisplayNamestring
readOnly: true
example: string : "John Smith"
Gets the formatted display name for the user.
}
401
Unauthorized access.
403
Forbidden.
500
An unknown error has ocurred. The ApiError will contain details about the error that was encountered.
#/definitions/ApiErrorApiError{
description:
Contains the details for an error that was encountered while accessing the Api.
ErrorMessagestring
example: string : "PC LOAD LETTER"
A message that describes the error that was encountered.
Detailsstring
example: string : "PC Load Letter? What does that mean!?"
Additional details that provide more information about the error.
ValidationErrors[
uniqueItems: false
An array of ApiValidationError object representing any validation errors that were encountered.
#/definitions/ApiValidationErrorApiValidationError{
description:
Contains the details for an validation error that was encountered while accessing the Api.
Fieldstring
example: string : "Patient.LastName"
The name of the field that caused the validation error.
Messagestring
example: string : "The value cannot be empty."
A message that describes the validation error that was encountered.
}]
}

Ccda

GET/api/v1/ccdas/{ccdaUid}/download
Returns a DownloadFileModel object which contains the requested CCDA and supporting documents.

Upon completion, the DownloadFileModel object will contain a compressed/zip file. The zip file includes the following document types :
[file].xml - The full XML representation of the CCDA
[file].xsl - The XSL stylesheet that is used to render the CCDA into human readable format.
[file].html - The rendered CCDA in human readable format.

Parameters

NameDescription
ccdaUid *
string($uuid)
(path)
The unique identifier of the CCDA that is to be downloaded.

Responses

CodeDescription
200
The operation was successful. Returns an DownloadFileModel which contains a file representation of the CCDA for the specified patient and search criteria.
#/definitions/DownloadFileModelDownloadFileModel{
description:
Contains the contents and information for a file download request.
Contents string($byte)

A byte array (or Base-64 encoded string) containing the contents of the file.
ContentTypestring
example: string : "application/octet-stream"
Contains the media type of the file content.
FileNamestring
example: string : "033003_Patient_20190101023011873.zip"
The name of the file.
}
401
Unauthorized access.
403
Forbidden.
500
An unknown error has ocurred. The ApiError will contain details about the error that was encountered.
#/definitions/ApiErrorApiError{
description:
Contains the details for an error that was encountered while accessing the Api.
ErrorMessagestring
example: string : "PC LOAD LETTER"
A message that describes the error that was encountered.
Detailsstring
example: string : "PC Load Letter? What does that mean!?"
Additional details that provide more information about the error.
ValidationErrors[
uniqueItems: false
An array of ApiValidationError object representing any validation errors that were encountered.
#/definitions/ApiValidationErrorApiValidationError{
description:
Contains the details for an validation error that was encountered while accessing the Api.
Fieldstring
example: string : "Patient.LastName"
The name of the field that caused the validation error.
Messagestring
example: string : "The value cannot be empty."
A message that describes the validation error that was encountered.
}]
}
GET/api/v1/ccdas/patients/{patientUid}/filter
Generates and returns a CcdaFileModel object which contains the CCDA for the specified patient and search criteria.

Upon completion, the CcdaFileModel.Contents property will contain the full XML representation of the CCDA.

Parameters

NameDescription
patientUid *
string($uuid)
(path)
The unique identifier of the patient.
fromDate
string($date-time)
(query)

(Optional) Include patient data that was recorded after this date.
toDate
string($date-time)
(query)

(Optional) Include patient data that was recorded before this date.
inc_allergies
boolean
(query)

(Optiona) Include allergies. (Default = true)
inc_assessment
boolean
(query)

(Optiona) Include assessment. (Default = true)
inc_procedures
boolean
(query)

(Optiona) Include procedures. (Default = true)
inc_currentMeds
boolean
(query)

(Optiona) Include current medications. (Default = true)
inc_encounters
boolean
(query)

(Optiona) Include encounters. (Default = true)
inc_functionalStatus
boolean
(query)

(Optiona) Include functional status. (Default = true)
inc_goals
boolean
(query)

(Optiona) Include goals. (Default = true)
inc_healthConcerns
boolean
(query)

(Optiona) Include health concerns. (Default = true)
inc_immunizations
boolean
(query)

(Optiona) Include immunizations. (Default = true)
inc_implantableDevices
boolean
(query)

(Optiona) Include implantable devices. (Default = true)
inc_labResults
boolean
(query)

(Optiona) Include lab results. (Default = true)
inc_mentalStatusExam
boolean
(query)

(Optiona) Include mental status exams. (Default = true)
inc_planOfCare
boolean
(query)

(Optiona) Include plan of care. (Default = true)
inc_smokingStatus
boolean
(query)

(Optiona) Include smoking status. (Default = true)
inc_vitals
boolean
(query)

(Optiona) Include vitals. (Default = true)

Responses

CodeDescription
200
The operation was successful. Returns an CcdaFileModel which contains the CCDA for the specified patient and search criteria.
#/definitions/CcdaFileModelCcdaFileModel{
description:
Contains the contents and identifier for a generated CCDA document.
CcdaUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier that represents the generated CCDA.
Contents string
example: string : "<?xml version='1.0'?>..."

If successful, the full XML representation of the CCDA.
ErrorMessage string
example: string : "PC LOAD LETTER"

If not successful, any error that was encountered during the generation process.
PatientUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier of the patient.
Successboolean
example: boolean - true
A flag indicating if the CCDA generation was successful.
}
401
Unauthorized access.
403
Forbidden.
500
An unknown error has ocurred. The ApiError will contain details about the error that was encountered.
#/definitions/ApiErrorApiError{
description:
Contains the details for an error that was encountered while accessing the Api.
ErrorMessagestring
example: string : "PC LOAD LETTER"
A message that describes the error that was encountered.
Detailsstring
example: string : "PC Load Letter? What does that mean!?"
Additional details that provide more information about the error.
ValidationErrors[
uniqueItems: false
An array of ApiValidationError object representing any validation errors that were encountered.
#/definitions/ApiValidationErrorApiValidationError{
description:
Contains the details for an validation error that was encountered while accessing the Api.
Fieldstring
example: string : "Patient.LastName"
The name of the field that caused the validation error.
Messagestring
example: string : "The value cannot be empty."
A message that describes the validation error that was encountered.
}]
}
GET/api/v1/ccdas/patients/{patientUid}
Generates and returns a CcdaFileModel object which contains the CCDA for the specified patient and search criteria.

Upon completion, the CcdaFileModel.Contents property will contain the full XML representation of the CCDA.

Parameters

NameDescription
patientUid *
string($uuid)
(path)
The unique identifier of the patient.
fromDate
string($date-time)
(query)

(Optional) Include patient data that was recorded after this date.
toDate
string($date-time)
(query)

(Optional) Include patient data that was recorded before this date.

Responses

CodeDescription
200
The operation was successful. Returns an CcdaFileModel which contains the CCDA for the specified patient and search criteria.
#/definitions/CcdaFileModelCcdaFileModel{
description:
Contains the contents and identifier for a generated CCDA document.
CcdaUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier that represents the generated CCDA.
Contents string
example: string : "<?xml version='1.0'?>..."

If successful, the full XML representation of the CCDA.
ErrorMessage string
example: string : "PC LOAD LETTER"

If not successful, any error that was encountered during the generation process.
PatientUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier of the patient.
Successboolean
example: boolean - true
A flag indicating if the CCDA generation was successful.
}
401
Unauthorized access.
403
Forbidden.
500
An unknown error has ocurred. The ApiError will contain details about the error that was encountered.
#/definitions/ApiErrorApiError{
description:
Contains the details for an error that was encountered while accessing the Api.
ErrorMessagestring
example: string : "PC LOAD LETTER"
A message that describes the error that was encountered.
Detailsstring
example: string : "PC Load Letter? What does that mean!?"
Additional details that provide more information about the error.
ValidationErrors[
uniqueItems: false
An array of ApiValidationError object representing any validation errors that were encountered.
#/definitions/ApiValidationErrorApiValidationError{
description:
Contains the details for an validation error that was encountered while accessing the Api.
Fieldstring
example: string : "Patient.LastName"
The name of the field that caused the validation error.
Messagestring
example: string : "The value cannot be empty."
A message that describes the validation error that was encountered.
}]
}

Patient

GET/api/v1/patients
Returns a list of SearchPatientModel objects based on the specified search and paging criteria.
The search results are returned within an SearchPatientsResultModel object which includes the current and available paging statistics.

Parameters

NameDescription
dob
string($date-time)
(query)

The patient’s date of birth.
firstName
string
(query)

The patient’s first name.
lastName
string
(query)

The patient’s last name.
medicalRecordNumber
string
(query)

The patient’s internal medical record number
policyNumber
string
(query)

A policy number for any of a patient’s insurance records.
phoneNumber
string
(query)
A phone number that is associated with a patient.
pageNumber
integer($int32)
(query)

The current active page of the search results. (Default = 1)
pageSize
integer($int32)
(query)

The number of patient records per page. (Default = 25)
sortColumn
string
(query)

The column that is to be used when sorting the patients. (Default = “lastname”)
Available values are - "active", "dob", "firstname", "gender", "lastname", "lastseenon", "mrnumber", "middleintial", "payorname", "phonenumber", “policynumber”

sortdirection
string
(query)

The direction in which to sort the patients. (Default = “asc”)
Available values are - "asc", “desc”

todaysAppointments
boolean
(query)

A flag to indicate whether or not to only include those patients that have an appointment today. (Default = false)

Responses

CodeDescription
200
The operation was successful. Returns an SearchPatientsResultModel that contains the search results and paging statistics.
#/definitions/SearchPatientsResultModelSearchPatientsResultModel{
description:
Contains the patient search results and paging statistics.
PageNumberinteger($int32)
example: int - 1
The current page number of the search results.
PageSizeinteger($int32)
example: int - 25
The number of patient records per page.
Results[...]
TotalPages integer($int32)
readOnly: true
example: int - 10

Based on the previous search criteria, the total number of pages in the search scope. (TotalRecords / PageSize)
TotalRecordsinteger($int32)
example: int - 100
The total number of patients that are available in the search results.
}
401
Unauthorized access.
403
Forbidden.
500
An unknown error has ocurred. The ApiError will contain details about the error that was encountered.
#/definitions/ApiErrorApiError{
description:
Contains the details for an error that was encountered while accessing the Api.
ErrorMessagestring
example: string : "PC LOAD LETTER"
A message that describes the error that was encountered.
Detailsstring
example: string : "PC Load Letter? What does that mean!?"
Additional details that provide more information about the error.
ValidationErrors[
uniqueItems: false
An array of ApiValidationError object representing any validation errors that were encountered.
#/definitions/ApiValidationErrorApiValidationError{
description:
Contains the details for an validation error that was encountered while accessing the Api.
Fieldstring
example: string : "Patient.LastName"
The name of the field that caused the validation error.
Messagestring
example: string : "The value cannot be empty."
A message that describes the validation error that was encountered.
}]
}

Models

AccountModel{
description:

Contains a summary view of the user’s account information.
AccountTypestring
example: AuthenticationAccountType : 2 (Portal)
Describes how this account is authenticated.
Enum:
[ Unknown, Global, Portal, Emr ]
AccountUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique account identifier that represents the user.
PracticeSynonymstring
example: string : "CCC453"
A synonym used to identify the practice that this account is associated with.
CustomerPracticeUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier that represents the practice.
Emailstring
example: string : "john.smith@relimedsolutions.com"
The email address associated with the account.
FirstNamestring
example: string : "John"
The first name of the user that is associated with this account.
LastNamestring
example: string : "Smith"
The last name of the user that is associated with this account.
LoginNamestring
example: string : "john.smith@relimedsolutions.com"
The login name used to access the account. This is usually the same as the Email.
DisplayNamestring
readOnly: true
example: string : "John Smith"
Gets the formatted display name for the user.
}
ApiError{
description:
Contains the details for an error that was encountered while accessing the Api.
ErrorMessagestring
example: string : "PC LOAD LETTER"
A message that describes the error that was encountered.
Detailsstring
example: string : "PC Load Letter? What does that mean!?"
Additional details that provide more information about the error.
ValidationErrors[
uniqueItems: false
An array of ApiValidationError object representing any validation errors that were encountered.
#/definitions/ApiValidationErrorApiValidationError{
description:
Contains the details for an validation error that was encountered while accessing the Api.
Fieldstring
example: string : "Patient.LastName"
The name of the field that caused the validation error.
Messagestring
example: string : "The value cannot be empty."
A message that describes the validation error that was encountered.
}]
}
ApiValidationError{
description:
Contains the details for an validation error that was encountered while accessing the Api.
Fieldstring
example: string : "Patient.LastName"
The name of the field that caused the validation error.
Messagestring
example: string : "The value cannot be empty."
A message that describes the validation error that was encountered.
}
DownloadFileModel{
description:
Contains the contents and information for a file download request.
Contents string($byte)

A byte array (or Base-64 encoded string) containing the contents of the file.
ContentTypestring
example: string : "application/octet-stream"
Contains the media type of the file content.
FileNamestring
example: string : "033003_Patient_20190101023011873.zip"
The name of the file.
}
CcdaFileModel{
description:
Contains the contents and identifier for a generated CCDA document.
CcdaUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier that represents the generated CCDA.
Contents string
example: string : "<?xml version='1.0'?>..."

If successful, the full XML representation of the CCDA.
ErrorMessage string
example: string : "PC LOAD LETTER"

If not successful, any error that was encountered during the generation process.
PatientUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier of the patient.
Successboolean
example: boolean - true
A flag indicating if the CCDA generation was successful.
}
SearchPatientsResultModel{
description:
Contains the patient search results and paging statistics.
PageNumberinteger($int32)
example: int - 1
The current page number of the search results.
PageSizeinteger($int32)
example: int - 25
The number of patient records per page.
Results[
uniqueItems: false
A list of the returned patient records.
#/definitions/SearchPatientsModelSearchPatientsModel{...}]
TotalPages integer($int32)
readOnly: true
example: int - 10

Based on the previous search criteria, the total number of pages in the search scope. (TotalRecords / PageSize)
TotalRecordsinteger($int32)
example: int - 100
The total number of patients that are available in the search results.
}
SearchPatientsModel{
description:

Contains a summary view of the patient’s information.
Activeboolean
example: boolean - true
A flag indicating if the patient is currently active.
DOB string($date-time)
example: Date - 01/01/1970

The patient’s date of birth.
EmailAddress string
example: string : "jane.smith@email.com"

The patient’s primary email address.
FirstName string
example: string : "Jane"

The patient’s first name.
Gender string
example: string : "F" (M, F, U)

The patient’s gender (code)
LastEncounterUid string($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"

The unique identifier of the patient’s last encounter.
LastName string
example: string : "Smith"

The patient’s last name.
LastSeenOnstring($date-time)
example: DateTime : 01/01/2019 08:00 AM
The date and time that the patient was last seen.
MiddleInitial string
example: string : "D"

The patient’s middle initial.
MRNumber string
example: string : "MR12345"

The patient’s internal medical record number
PatientUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier that represents the patient.
PayorName string
example: string : "Vandelay Industries"

The name of the payor associated with the patient’s primary insurance.
PhoneNumber number($double)
example: decimal : "5558675309"

The patient’s primary phone number.
PolicyNumber string
example: string : "A123456789"

The policy number for the patient’s primary insurance.
PreferredLocationUid string($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"

The unique identifier that represents the patient’s preferred location.
PatientName string
readOnly: true
example: string : "Jane Smith"

Gets the formatted display name for the patient : (FirstName) (LastName)
PatientFullName string
readOnly: true
example: string : "Jane D. Smith"

Gets the formatted full name for the patient : (FirstName) (MiddleInitial) (LastName)
RelationshipNamestring
example: string : "Self"
The relationship between the current user and the patient.
RelationshipUidstring($uuid)
example: Guid : "588a074d-0860-4141-854d-eae2f9dcdca1"
The unique identifier that represents the relationship type.
}