API Developer Portal2024-02-02T12:41:43+00:00

API Developer Portal

Elixir Application API access | Patient Population Selection

Prerequisite: Token generator

Parameters

  • grant_type: client_credentials
  • client_id: Enter the client Id
  • client_secret: enter the client secret key

Response

{
“access_token”: “String”,
“signature”: “String”,
“instance_url”: “https://{salesforce_Instance}”,
“id”: “String”,
“token_type”: “String”,
“issued_at”: “String”
}

Use the access_token generated for the successive HTTP requests

Application Access Patient Selection: FHIR APIs

Parameters

  • accountId= {}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • visitId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • visitId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • visitId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • allergyId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • problemId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • diagnosisId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • insuranceId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • organizationId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • procedureId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • laborderId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • medicationId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • locationId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

Parameters

  • careteamId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “string”
}

All Data Request: CCDA

Overview:

The C-CDA API returns a Continuity of Care Document (CCD) formatted in accordance with the C-CDA API version 2.1 specification.

Body
{
“CDAType”:”Consolidated CDA”,
“strAccountId”: “String”
}

Error Handling and Conditions

Response Code

  • 400

Response Format

  • Bad request

Response message

{“resourceType”: “OperationOutcome”
“issue”: [
{
“code”: “invalid”,
“details”: {
“text”: “Not found” },
“severity”: “error”
}
],
}


Response Code

  • 401

Response Format

  • Error Message

Response message

{“resourceType”: “OperationOutcome”
“issue”: [
{
“code”: “invalid”,
“details”: {
“text”: “Not found” },
“severity”: “error”
}
],
}


Response Code

  • 403

Response Format

  • Forbidden

Response message

{“resourceType”: “OperationOutcome”
“issue”: [
{
“code”: “invalid”,
“details”: {
“text”: “Not found” },
“severity”: “error”
}
],
}


Response Code

  • 404

Response Format

  • Not Found

Response message

{“resourceType”: “OperationOutcome”
“issue”: [
{
“code”: “invalid”,
“details”: {
“text”: “Not found” },
“severity”: “error”
}
],
}