API Developer Portal

Terms of Service Application access patient selection – g(7)

Elixir APIs enable healthcare organizations to seamlessly connect with their FHIR API’s and All Data Request, ensuring compliance with the Cures Act requirements and beyond.

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

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

  • 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”
}

Terms and Conditions
  1. Data must be accessed responsibly and comply with all HIPAA regulations.
  2. Access is restricted to authorized users and permitted applications.
  3. The API is subject to maintenance; downtime may occur during scheduled updates.
Application Access Patient Selection: FHIR APIs g(7) GET

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

  • visitId={}

Response

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

Parameters

  • diagnosisId={}

Response

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

Parameters

  • problemId={}

Response

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

Parameters

  • problemId={}

Response

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

Parameters

  • problemId={}

Response

{
“resourceType”: “string”,
“additionalProp2”: “string”,
“additionalProp3”: “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”
}
],
}

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”
}

Error Handling and Exceptions

Error responses follow HTTP status codes. Common errors include:

  • 404 Not Found: Resource with specified Id does not exist.
  • 401 Unauthorized: Invalid API key or credentials.
  • 500 Internal Server Error: General error on the server; try again later.

Each error returns a JSON object with an errorCode and message field for troubleshooting.

Software Requirements
  • HTTP Client Library: For sending RESTful requests.
  • OAuth 2.0 or API Key authentication setup for access.
  • JSON Parsing Library: For handling responses in JSON format.

Why Mirketa ?

Industry & Tech experts with years of experience enabling transformation.

2M+

Hours of Cloud Experience

Empowering SMBs and enterprises alike with a bespoke approach.

100+

Clients

Since 2013, helping clients in their digital transformation initiatives

9.5/10

Consistently high customer experience scores

Achieve unmatched adaptability with our dynamic, open, and innovative partner ecosystem

1000+

Successful projects

You Have Questions,
We Have Answers

Talk to our experts today and explore how we can help you build a connected and efficient digital ecosystem.