teleconsulting

1. First Search

Searches for teleconsultation services by category. Beckn search action; results arrive at on_search.

POST/api/teleconsulting/search

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

contextobjectRequired

context.domainstringRequired

context.countrystringRequired

context.citystringRequired

context.actionstringRequired

context.core_versionstringRequired

context.consumer_idstringRequired

context.consumer_uristringRequired

context.message_idstringRequired

context.timestampstringRequired

context.transaction_idstringRequired

messageobjectRequired

message.intentobjectRequired

message.intent.categoryobjectRequired

message.intent.category.descriptorobjectRequired

message.intent.fulfillmentobjectRequired

message.intent.fulfillment.agentobjectRequired

message.intent.fulfillment.typestringRequired

message.intent.fulfillment.startobjectRequired

message.intent.fulfillment.endobjectRequired

message.intent.itemobjectRequired

message.intent.item.descriptorobjectRequired

Responses

200

Example values, scrubbed.

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

1. First Search

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/teleconsulting/search \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "context": {
    "domain": "nic2004:85111",
    "country": "IND",
    "city": "std:011",
    "action": "search",
    "core_version": "0.7.1",
    "consumer_id": "aarogyaSetu.eua",
    "consumer_uri": "https://aarogyasetu-sandbox.abdm.gov.in/aarogyasetu/api/v3/app/api/teleconsulting",
    "message_id": "<TXN_ID>",
    "timestamp": "2022-07-05T15:24:35",
    "transaction_id": "<TXN_ID>"
  },
  "message": {
    "intent": {
      "category": {
        "descriptor": {
          "code": "CARDIOLOGY",
          "name": "<NAME>"
        }
      },
      "fulfillment": {
        "agent": {
          "name": "<NAME>"
        },
        "type": "Online",
        "start": {
          "time": {
            "timestamp": "2022-07-15T00:00:00"
          }
        },
        "end": {
          "time": {
            "timestamp": "2022-07-16T00:00:00"
          }
        }
      },
      "item": {
        "descriptor": {
          "code": "Consultation",
          "name": "<NAME>"
        }
      }
    }
  }
}'

{
  "message": {
    "ack": {
      "status": "ACK"
    }
  }
}

Generated from the schema. The values are placeholders, not a captured response.