Consultar ordens

Consultar ordens da sua organização na Eden

Por meio deste serviço você poderá consultar as ordens de exame que estão registradas no Edén. Dessa forma, você poderá manter seu sistema atualizado com as informações geradas no Edén, como o status de cada ordem ou como saber se as imagens já foram capturadas

Orders list.

get

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

/orders/

List all orders.

Autorizações

Token

AuthorizationstringObrigatório

Parâmetros de consulta

start_datestringOpcional

Start date in ISO 8601 format. Mandatory if end_date is not specified. The difference between the start date and the end date cannot be more than one month. Example: "?start_date=2024-11-11T00:00:00-06:00".

end_datestringOpcional

End date in ISO 8601 format. Mandatory if start_date is not specified. The difference between the start date and the end date cannot be more than one month.

updated_start_datestringOpcional

Updated at Start date in ISO 8601 format. The difference between the updated start date and the updated end date cannot be more than one month. Example: "2024-01-01T00:00:00Z".

updated_end_datestringOpcional

Updated at End date in ISO 8601 format. The difference between the updated start date and the updated end date cannot be more than one month. Example: "2024-01-31T23:59:59Z".

modalitystringOpcional

Modality identifiers. In order to specify more than one, this parameter must be repeated. Example: "?modality=MG&modality=CT".

facilitystringOpcional

Facilities UUIDs. In order to specify more than one, this parameter must be repeated. Example: "?facility=id1&facility=id2".

roomstringOpcional

Rooms UUIDs. In order to specify more than one, this parameter must be repeated. Example: "?room=id1&room=id2".

patient_identifierstringOpcional

Identifier of the patient. Example: "?patient_identifier=ARCP-901212-001".

statusstringOpcional

Order status to filter query. Order status: - NEW - PATIENT_ARRIVED - IN_PROCESS - COMPLETED

Study status (only for COMPLETED orders):
- READING_PENDING
- READING
- SIGNED
- REVIEW_PENDING
- DELIVERED
- IMAGES_SENT
- IN_ADDENDUM
- ADDENDUM_SIGNED

Example: "?status=COMPLETED&status=SIGNED"

limitstringOpcional

Maximum number of items that will be returned per page. Defaults to 10.

offsetstringOpcional

Determines where the current page of data should start within the entire dataset. It represents the number of items that should be skipped before starting to display the items on the current page. Defaults to 0.

orderingstringOpcional

Determines the field by which the dataset will be sorted and the direction in which it will be sorted. The field and direction option are specified, separated by a comma. The values that the direction can take are "asc" and "desc" for ascending and descending respectively. Defaults to "created_at,asc".

Respostas

200

A successful response that returns orders.

application/json

400

A failed response because the required parameters were not received or because they contain an error.

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

500

A failed response due to a server problem.

application/json

get

/orders/

HTTPcURLJavaScriptPython

GET /api/v1/orders/ 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",
  "total_count": 1
}