Get an order

Get an order by its id or the related reference number

You can also obtain the information of an order by filtering by one of these two parameters:

• id : order identifier, the identifier is of UUID type

• folio : Study identifier, assigned by the hospital. Max length is 80 characters. You can use 'accession_number' as an alias for this field

Order detail.

get

https://middleware-staging.dev-land.space/api/v1http://middleware-staging.dev-land.space/api/v1

/orders/{id}/

Gets the detail of an order.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

200

A successful response that returns the order details.

application/json

401

A failed response due to insufficient permissions to execute the operation.

application/json

403

A failed response due to not having the proper permissions.

application/json

404

A failed response because the required order was not found.

application/json

500

A failed response due to a server problem.

application/json

get

/orders/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/orders/{id}/ HTTP/1.1
Host: middleware-staging.dev-land.space
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": "text",
    "folio": "text",
    "priority": "text",
    "description": "text",
    "comments": "text",
    "referring_practitioner": {
      "id": "text",
      "external_identifier": "text",
      "full_name": "text",
      "name": "text",
      "first_surname": "text",
      "last_surname": "text",
      "user": {
        "email": "text"
      },
      "gender": "text"
    },
    "created_at": "text",
    "status": "text",
    "viewer_link": "text",
    "pdf_url": "text",
    "pdf_letterhead_url": "text",
    "study_viewer_link": "text",
    "public_study_viewer_link": "text",
    "report_viewer_link": "text",
    "report_pdf_url": "text",
    "report_pdf_letterhead_url": "text",
    "pacs_study": {
      "id": "text",
      "dicom_date_time": "text",
      "status": "text",
      "reports": [
        {
          "signed_by": {
            "full_name": "text",
            "user": {
              "email": "text"
            },
            "identifier": "text"
          },
          "fields": [
            {
              "value": "text"
            }
          ]
        }
      ],
      "study_pdf_files": [
        {
          "file_url": "text",
          "status": "text",
          "updated_at": "text"
        }
      ]
    },
    "management_study": {
      "id": "text",
      "name": "text",
      "code": {
        "id": "text",
        "code": "text",
        "name": "text"
      },
      "modality": {
        "id": "text",
        "identifier": "text"
      }
    },
    "patient": {
      "id": "text",
      "full_name": "text",
      "gender": "text",
      "birth_date": "text",
      "identifier": "text",
      "email": "text",
      "phone_number": "text",
      "phone_code": "text",
      "phone_country": {
        "id": "text",
        "iso_code": "text"
      },
      "patient_data": {
        "sale_channel": {
          "id": "text",
          "name": "text"
        }
      }
    },
    "modality": {
      "id": "text",
      "identifier": "text"
    },
    "facility": {
      "id": "text",
      "name": "text"
    },
    "room": {
      "id": "text",
      "name": "text"
    },
    "appointment": {
      "id": "text",
      "start_date": "text",
      "end_date": "text"
    },
    "nursing_unit": {
      "identifier": "text",
      "name": "text",
      "description": "text"
    }
  },
  "errors": {},
  "success": "true"
}