API docs by Redocly

AI Risk Encounter (1.2.6)

Download OpenAPI specification:Download

API for managing patient records

Service Token Retrieval

Obtaining a Bearer service token to make API requests

Authenticate and retrieve an access token

This endpoint authenticates users and provides access tokens for subsequent API calls. In production additional HTTP response headers like X-Frame-Options, X-XSS-Protection, and Content-Security-Policy would be included to enhance security against common web vulnerabilities. Please note this token expires every hour and a new token can be requested using the same API.

Authorizations:
apiKeyHeader
header Parameters
X-API-KEY
required
string
Request Body schema: application/json
required
clientId
required
string

Unique Allymar defined ID for the client

secret
required
string

Allymar provided client secret information

username
required
string

Name of the user using the system

organizationId
required
string

Allymar defined organization identifier

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "secret": "string",
  • "username": "string",
  • "organizationId": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "tokenType": "Bearer",
  • "expiresIn": 3600
}

CRUD Operations

Operations to Create, Read, Update, and Delete patient records

Create a new patient record

Called to create patient records. Please note patient MRN, memberId, date of birth, gender and name are important fields in matching patient records. Before creating a patient record a query is issued to check if the patient already exists based on MRN, DoB, and memberID

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
firstName
required
string
middleName
required
string
lastName
required
string
dob
required
string <date>

Date of Birth in MM-DD-YYYY format.

memberId
required
string
MRN
required
string
gender
required
string
Enum: "Male" "Female" "Unknown"
subscriberKey
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "dob": "10-24-1958",
  • "memberId": "string",
  • "MRN": "string",
  • "gender": "Male",
  • "subscriberKey": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "patientId": "string"
}

Retrieve a patient record by ID

Authorizations:
service
path Parameters
patientId
required
string

Allymar generated Patient Identifier provided during the patient create.

header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Responses

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "dob": "10-24-1958",
  • "memberId": "string",
  • "MRN": "string",
  • "gender": "Male",
  • "subscriberKey": "string",
  • "address": {
    }
}

Update an existing patient record

Authorizations:
service
path Parameters
patientId
required
string

Allymar generated Patient Identifier provided during the patient create.

header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
firstName
required
string
middleName
required
string
lastName
required
string
dob
required
string <date>

Date of Birth in MM-DD-YYYY format.

memberId
required
string
MRN
required
string
gender
required
string
Enum: "Male" "Female" "Unknown"
subscriberKey
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "dob": "10-24-1958",
  • "memberId": "string",
  • "MRN": "string",
  • "gender": "Male",
  • "subscriberKey": "string",
  • "address": {
    }
}

Delete a patient record

Authorizations:
service
path Parameters
patientId
required
string

Allymar generated Patient Identifier provided during the patient create.

header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Responses

Search for patient records

Provide available patient details for a search. Some minimum fields would be required for an effective search

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
firstName
required
string
middleName
required
string
lastName
required
string
dob
required
string <date>

Date of Birth in MM-DD-YYYY format.

memberId
required
string
MRN
required
string
gender
required
string
Enum: "Male" "Female" "Unknown"
subscriberKey
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "dob": "10-24-1958",
  • "memberId": "string",
  • "MRN": "string",
  • "gender": "Male",
  • "subscriberKey": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "patientId": "string"
}

Patient Dx PreLoad

Preload any Dx findings that are known prior to encounter processing.

Pre-load Diagnosis(Dx) data for a patient.

This endpoint accepts Diagnosis(Dx) data for a patient, which includes a list of specific health condition codes and descriptions, to pre-load into the system.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

Allymar Patient identifier.

required
Array of objects (DiagnosisDetail)

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "dxList": [
    ]
}

Get Patient Dx PreLoad

Get Pre-load Diagnosis(Dx) data for a patient.

Get Pre-load Diagnosis(Dx) data for a patient.

This endpoint accepts Patient ID and provides Pre-Load Diagnosis data for that Patient.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

Allymar Patient identifier.

Responses

Request samples

Content type
application/json
{
  • "patientId": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Client AES 256 Encryption Key

Obtain AES Encryption key from the client which should be used to decode the CCDA file that is passed.

Receive AES key for CCDA file encryption.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
encryptionKey
required
string

AES 256-bit encryption key, encoded in Base64.

Responses

Request samples

Content type
application/json
{
  • "encryptionKey": "string"
}

Patient Encounter Clinical Notes Update

Operations to update patient's clinical notes encounter

Post encounter notes for a specific patient

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

Patient Allymar unique identifier

encounterId
required
string

Unique identifier for the encounter

required
object
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "encounterId": "string",
  • "dos": {
    },
  • "clinicalNotes": [
    ]
}

Upload Patient Encounter CCDA

Recieves Patient encounter CCDA Document

Upload a CCDA document for a patient encounter.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: multipart/form-data

Media type of the body of the request.

Request Body schema: multipart/form-data
patientId
string

Allymar Patient identifier, an optional parameter.

encounterId
required
string

Encounter ID for the patient, a required parameter.

dosStart
required
string <date>

Required start date of service, formatted as MM-DD-YYYY.

dosEnd
required
string <date>

Required end date of service, formatted as MM-DD-YYYY.

ccdaFile
required
string <binary>

AES 256-bit encrypted CCDA file.

Responses

Upload Patient Medical Chart

Multipart Medical Chart Ingestion API for PDF Submission and Processing

Multipart Medical Chart Ingestion API for PDF Submission and Processing

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: multipart/form-data

Media type of the body of the request.

Request Body schema: multipart/form-data
patientId
required
string

Allymar Patient identifier.

encounterId
required
string

Encounter ID for the patient, a required parameter.

dosStart
required
string <date>

Required start date of service, formatted as MM-DD-YYYY.

dosEnd
required
string <date>

Required end date of service, formatted as MM-DD-YYYY.

providerName
required
string

Provider Name

providerNPI
required
string

Provider NPI

chart
required
string <binary>

PDF file.

Responses

Get Patients List

Retrieves a paginated list of patients from the database.

Retrieve patients list

Retrieves a paginated list of patients from the database.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
page
required
integer

The page number.

pageSize
required
integer

The number of patient entries per page.

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0
}

Response samples

Content type
application/json
{
  • "recordCount": 0,
  • "Patients": [
    ]
}

Get Patient Dx

Provides all the Dx identified for the patient based on specified filter criteria in the API.

Retrieve diagnosis information for a specific patient

Returns diagnosis details based on patient ID and other optional filters.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

Unique identifier for the patient

dxType
required
string
Default: "Accept"
Enum: "All" "Accept" "Reject" "Pending"

Return type for the Diagnoses (All, Accept, Reject, or Pending)

encounterId
string

Specific encounter identifier. Please note this identifier is not Allymar specific and is provided by the client.

dx
required
string
Default: "HCC"
Enum: "HCC" "All" "HCCPreDx"

Type of diagnosis to retrieve (HCC or All)

dosYear
string

Year of service

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "dxType": "All",
  • "encounterId": "string",
  • "dx": "HCC",
  • "dosYear": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Patient Dx Evidence

Provides all the evidence associated with the Dx

Retrieve document evidence for a diagnosis gap

Returns document evidence linked to specific diagnosis gaps for a patient.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

Unique identifier for the patient

gapId
required
string

Unique identifier for the diagnosis gap

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "gapId": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Patient Dx Feedback

Indicate the feedback for the provided Dx Gap. This is useful if this is managed externally.

Submit feedback for Diagnosis(Dx) of a patient.

This endpoint allows for submitting feedback on previously loaded Diagnosis(Dx) data, including acceptance, rejection, or pending status for specific Diagnosis(Dx) gaps.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

Allymar Patient identifier.

required
Array of objects (DiagnosisFeedback)

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "dxList": [
    ]
}

Get Encounter details

This endpoint is used for providing the encounter update details for CCDA, Clinical notes and PDF.

Get encounter processing update

This endpoint is used for providing the encounter update details for CCDA, Clinical notes and PDF.

Authorizations:
service
header Parameters
Authorization
required
string

Authentication Bearer token to allow request to be processed. This is the token that is provided during the 'token' API request.

Content-Type
required
string
Default: application/json

Media type of the body of the request.

Request Body schema: application/json
required
patientId
required
string

Allymar Patient identifier.

encounterId
required
string

Encounter ID for the patient.

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "encounterId": "string"
}

Response samples

Content type
application/json
{
  • "message": "Encounter <Enounter ID> has complete execution",
  • "start": "2024-11-06T03:40:25.178592+00:00",
  • "end": "2024-11-06T03:40:42.944057+00:00"
}