teleconsulting

2. Second Search

Refines a teleconsultation search, for example by provider or time slot. Beckn search action; results arrive at on_search.

POST/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.provider_idstringRequired

context.message_idstringRequired

context.timestampstringRequired

context.provider_uristringRequired

context.transaction_idstringRequired

messageobjectRequired

message.intentobjectRequired

message.intent.providerobjectRequired

message.intent.provider.idstringRequired

message.intent.provider.categoriesobject[]Required

message.intent.provider.fulfillmentsobject[]Required

message.intent.provider.itemsobject[]Required

Responses

200

Example values, scrubbed.

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

2. Second Search

curl --request POST \
  --url https://phrsbx.abdm.gov.in/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",
    "provider_id": "hspa-nha",
    "message_id": "<TXN_ID>",
    "timestamp": "<TXN_ID>",
    "provider_uri": "https://hspasbx.abdm.gov.in/api/v1",
    "transaction_id": "<TXN_ID>"
  },
  "message": {
    "intent": {
      "provider": {
        "id": "1",
        "categories": [
          {
            "id": "201",
            "parent_category_id": "101",
            "descriptor": {
              "name": "<NAME>",
              "code": "CARDIOLOGY"
            }
          },
          {
            "id": "101",
            "descriptor": {
              "name": "<NAME>",
              "code": "ALLOPATHY"
            }
          }
        ],
        "fulfillments": [
          {
            "type": "Online",
            "agent": {
              "id": "<EMAIL>",
              "image": null
            },
            "start": {
              "time": {
                "timestamp": "2024-06-25T10:30:27"
              }
            },
            "end": {
              "time": {
                "timestamp": "2024-06-25T23:59:59"
              }
            }
          }
        ],
        "items": [
          {
            "id": "1",
            "descriptor": {
              "name": "<NAME>",
              "code": "CONSULTATION"
            },
            "price": {
              "currency": "INR",
              "value": "0.0"
            },
            "fulfillment_id": "1",
            "category_id": "201"
          }
        ]
      }
    }
  }
}'

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

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