v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Procedures

View procedure

This endpoint returns a single procedure by its NexHealth id. Note: the list endpoint is not filtered by your token's location access, so ids returned by GET /procedures may return 404 here if the procedure belongs to a location your token cannot access or has no location assigned.

get/procedures/{id}

Path parameters

idinteger required

The ID of the procedure

Query parameters

subdomainstring required

Used to scope the request to the specified institution

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": 11,
    "location_id": 21,
    "patient_id": 162,
    "provider_id": 84,
    "appointment_id": 283,
    "code": "D6100",
    "name": "Implant Removal",
    "status": "referred",
    "updated_at": "2020-06-05T20:16:57.007Z",
    "body_site": {
      "tooth": [
        "3",
        "14"
      ],
      "surface": "MOD"
    },
    "fee": {
      "amount": "62.00",
      "currency": "USD"
    },
    "start_date": "2022-06-24",
    "end_date": "2022-06-24",
    "treatment_plan_ids": [
      42,
      57
    ]
  },
  "count": 2
}