teleconsulting

6. On_update

Updates a teleconsultation order, for example to reschedule. Beckn update action; the reply arrives at on_update.

POST/teleconsulting/update

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

context.provider_uristringRequired

context.transaction_idstringRequired

messageobjectRequired

message.orderobjectRequired

message.order.idstringRequired

message.order.statestringRequired

message.order.itemobjectRequired

message.order.item.idstringRequired

message.order.item.descriptorobjectRequired

message.order.fulfillmentobjectRequired

message.order.fulfillment.idstringRequired

message.order.fulfillment.typestringRequired

message.order.fulfillment.agentobjectRequired

message.order.fulfillment.startobjectRequired

message.order.fulfillment.endobjectRequired

message.order.fulfillment.tagsobjectRequired

message.order.termsobject[]Required

message.order.terms.typestringRequired

message.order.terms.descriptorobjectRequired

message.order.terms.reasonRequiredbooleanRequired

message.order.terms.timePeriodstringRequired

message.order.terms.reasonstringRequired

message.order.terms.termsStatestringRequired

message.order.billingobjectRequired

message.order.billing.namestringRequired

message.order.billing.addressobjectRequired

message.order.billing.emailstringRequired

message.order.billing.phonestringRequired

message.order.paymentobjectRequired

message.order.payment.uristringRequired

message.order.payment.typestringRequired

message.order.payment.statusstringRequired

message.order.payment.tl_methodstringRequired

message.order.payment.paramsobjectRequired

message.order.quoteobjectRequired

message.order.quote.priceobjectRequired

message.order.quote.breakupobject[]Required

message.order.customerobjectRequired

message.order.customer.personobjectRequired

message.order.customer.idstringRequired

message.order.providerobjectRequired

message.order.provider.idstringRequired

Responses

200

Example values, scrubbed.

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

6. On_update

curl --request POST \
  --url https://phrsbx.abdm.gov.in/teleconsulting/update \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "context": {
    "domain": "nic2004:85111",
    "country": "IND",
    "city": "std:011",
    "action": "on_update",
    "core_version": "0.7.1",
    "consumer_id": "phr.euapid.bb",
    "consumer_uri": "https://d2xk0g5obixbh6.cloudfront.net/aarogyasetu/api/v3/app/api/teleconsulting",
    "message_id": "<TXN_ID>",
    "timestamp": "2022-07-05T15:24:35.481906",
    "provider_id": "hspa-nha",
    "provider_uri": "http://hspasbx.abdm.gov.in/api/v1",
    "transaction_id": "<TXN_ID>"
  },
  "message": {
    "order": {
      "id": "8441-696786-1042",
      "state": "DOCTOR_NO_SHOW",
      "item": {
        "id": "1",
        "descriptor": {
          "code": "Consultation",
          "name": "<NAME>"
        }
      },
      "fulfillment": {
        "id": "<TXN_ID>",
        "type": "Online",
        "agent": {
          "id": "<EMAIL>",
          "name": "<NAME>",
          "gender": "F",
          "tags": {
            "@abdm/gov.in/education": "MBBS,MS",
            "@abdm/gov.in/experience": "15.0",
            "@abdm/gov.in/languages": "English, Hindi, Marathi",
            "@abdm/gov.in/hpr_id": "<ABHA_NUMBER>,",
            "@abdm/gov.in/hfr_id": "<ABHA_NUMBER>"
          }
        },
        "start": {
          "time": {
            "timestamp": "2022-09-15T15:00:00"
          }
        },
        "end": {
          "time": {
            "timestamp": "2022-09-15T15:15:00"
          }
        },
        "tags": {
          "@abdm/gov.in/teleconsultation/uri": "www.callmyhspa.com/tele"
        }
      },
      "terms": [
        {
          "type": "Commercial",
          "descriptor": {
            "name": "<NAME>",
            "short_desc": "Short description of commercial terms",
            "long_desc": "Long descripiton of commercial terms"
          },
          "reasonRequired": false,
          "timePeriod": "2024-11-12T09:00:00",
          "reason": "",
          "termsState": "AGREED"
        },
        {
          "type": "Settlement",
          "descriptor": {
            "name": "<NAME>",
            "short_desc": "Short description of settlement terms",
            "long_desc": "Long descripiton of settlement terms"
          },
          "reasonRequired": false,
          "timePeriod": "2024-11-12T09:00:00",
          "reason": "",
          "termsState": "AGREED"
        },
        {
          "type": "Cancellation",
          "descriptor": {
            "name": "<NAME>",
            "short_desc": "Short description of cancellation terms",
            "long_desc": "Long descripiton of cancellation terms"
          },
          "reasonRequired": false,
          "timePeriod": "2024-11-12T09:00:00",
          "reason": "",
          "termsState": "AGREED"
        },
        {
          "type": "Refund",
          "descriptor": {
            "name": "<NAME>",
            "short_desc": "Short description of refund terms",
            "long_desc": "Long descripiton of refund terms"
          },
          "reasonRequired": false,
          "timePeriod": "2024-11-12T09:00:00",
          "reason": "",
          "termsState": "AGREED"
        },
        {
          "type": "Payment",
          "descriptor": {
            "name": "<NAME>",
            "short_desc": "Short description of payment terms",
            "long_desc": "Long descripiton of payment terms"
          },
          "reasonRequired": false,
          "timePeriod": "2024-11-12T09:00:00",
          "reason": "",
          "termsState": "AGREED"
        }
      ],
      "billing": {
        "name": "<NAME>",
        "address": {
          "door": "",
          "name": "<NAME>",
          "locality": "",
          "city": "Pune",
          "state": "Maharashtra",
          "country": "INDIA",
          "area_code": "412115"
        },
        "email": "<EMAIL>",
        "phone": "<MOBILE>"
      },
      "payment": {
        "uri": "https://api.bpp.com/pay?amt=1500&txn_id=ksh87yriuro34iyr3p4&mode=upi&vpa=sana.bhatt@upi",
        "type": "PRE-ORDER",
        "status": "PAID",
        "tl_method": "http/get",
        "params": {
          "transaction_id": "1",
          "amount": "1000",
          "mode": "UPI",
          "vpa": "xyz@ghh",
          "redirect_url": "https://uhieuasandbox.abdm.gov.in/on_paymentStatus? transaction_id=1&payment_status=success"
        }
      },
      "quote": {
        "price": {
          "currency": "INR",
          "value": "1000"
        },
        "breakup": [
          {
            "title": "Consultation",
            "price": {
              "currency": "INR",
              "value": "1000"
            }
          },
          {
            "title": "CGST @ 5%",
            "price": {
              "currency": "INR",
              "value": "0"
            }
          },
          {
            "title": "SGST @ 5%",
            "price": {
              "currency": "INR",
              "value": "0"
            }
          },
          {
            "title": "Registration",
            "price": {
              "currency": "INR",
              "value": "0"
            }
          }
        ]
      },
      "customer": {
        "person": {
          "gender": "M",
          "dob": "<DATE_OF_BIRTH>",
          "dayOfBirth": 21,
          "monthOfBirth": 11,
          "yearOfBirth": 2022
        },
        "id": "satishc661994@sbx"
      },
      "provider": {
        "id": "1"
      }
    }
  }
}'

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

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