Crear una orden

Al ser una API REST, cada método HTTP tiene el significado esperado, para realizar la creación se utiliza el método POST.

Los datos que se necesitan mandar para la creación incluyen:

• Datos demográficos del paciente

• Información sobre el estudio o procedimiento

• Información de la unidad / sucursal donde se realizará el estudio

• Información sobre el médico referente (Opcional)

• Informacion del agendamiento (Opcional)

Create an order.

post

https://middleware.evacenter.com/api/v1http://middleware.evacenter.com/api/v1

/orders/

Creates a new order from the provided data.

Authorizations

Token

AuthorizationstringRequired

Body

application/json

foliostringRequired

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

descriptionstringRequired

Description of the order (reason for doing the study). Max length is 255 characters. You can use 'requested_procedure_description' as an alias for this field.

facility_identifierstringRequired

Unique facility identifier. Max length is 40 characters.

modalitystringRequired

Modality identifier. Max length is 20 characters.

prioritystringOptional

Order priorities (NORMAL, HIGHEST, URGENT). It is used to define the priority of an order.

extra_fieldsobjectOptional

The extra field API attribute allows you to send custom fields in JSON format ({'key': 'value'}) that are not available in the service, which can then be mapped in the study report.

room_identifierstringOptional

Room AETITLE or slug.

room_namestringOptional

Room name, it is an optional field, it is recommended to send it when the room_identifier is not sent

study_codestringRequired

Study code (internal identifier). Max length is 20 characters.

study_namestringRequired

The name of the study type. Max length is 255 characters.

patient_identifierstringOptional

Patient's unique identifier. Max length is 255 characters. You can use 'patient_id' as an alias for this field.

patient_namestringRequired

Patient's names. Max length is 255 characters.

patient_first_surnamestringOptional

Patient's principal surname. Max length is 255 characters.

patient_last_surnamestringOptional

Patient's second surname. Max length is 255 characters.

patient_emailstringOptional

Patient's email. Max length is 80 characters.

patient_genderstringRequired

Patient's gender (F, M, O). You can use 'patient_sex' as an alias for this field.

patient_birth_datestringRequired

Patient's birthdate in ISO-8601 format. You can use 'patient_birthdate' as an alias for this field.

patient_phone_codestringOptional

Phone code of the country to which the telephone number belongs according to the ISD standard. Max length is 3 characters.

patient_phone_numberstringOptional

Patient's phone number.

physician_identifierstringOptional

Referring physician's custom identifier.

physician_namestringOptional

Referring physician's name. Max length is 255 characters.

physician_first_surnamestringOptional

Referring physician's first surname. Max length is 255 characters.

physician_last_surnamestringOptional

Referring physician's last surname. Max length is 255 characters.

physician_emailstringOptional

Referring physician's email. Identifier of the physician in our platform. Max length is 80 characters.

physician_genderstringOptional

Referring physician's gender (F, M, O).

physician_phone_codestringOptional

Phone code of the country to which the telephone number belongs according to the ISD standard. Max length is 3 characters.

physician_phone_numberstringOptional

Referring physician's phone number.

practitioner_assigned_emailstringOptional

Practitioner's email. Identifier of the practitioner in our platform. Max length is 80 characters.

appointment_datestringOptional

Date you want to create the appointment, datefield format: YYYY-MM-DD

appointment_timestringOptional

Time you want to create the appointment, time format: HH:MM:SS, in 24 hour format

appointment_durationintegerOptional

Duration of the appointment in minutes, for example 30

Responses

201

A successful response that returns the order details.

application/json

400

A failed response because the required parameters were not received.

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

post

/orders/

HTTPcURLJavaScriptPython

POST /api/v1/orders/ HTTP/1.1
Host: middleware.evacenter.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 794

{
  "folio": "text",
  "description": "text",
  "facility_identifier": "text",
  "modality": "text",
  "priority": "text",
  "extra_fields": {},
  "room_identifier": "text",
  "room_name": "text",
  "study_code": "text",
  "study_name": "text",
  "patient_identifier": "text",
  "patient_name": "text",
  "patient_first_surname": "text",
  "patient_last_surname": "text",
  "patient_email": "text",
  "patient_gender": "text",
  "patient_birth_date": "text",
  "patient_phone_code": "text",
  "patient_phone_number": "text",
  "physician_identifier": "text",
  "physician_name": "text",
  "physician_first_surname": "text",
  "physician_last_surname": "text",
  "physician_email": "text",
  "physician_gender": "text",
  "physician_phone_code": "text",
  "physician_phone_number": "text",
  "practitioner_assigned_email": "text",
  "appointment_date": "text",
  "appointment_time": "text",
  "appointment_duration": 1
}

{
  "data": {
    "id": "text",
    "status": "text",
    "folio": "text",
    "patient_id": "text",
    "patient_identifier": "text",
    "patient_name": "text"
  },
  "errors": {},
  "success": "true"
}

Nota Para realizar la creación de una orden, el identificador de la sucursal <facility_identifier> es requerido en nuestro ambiente de staging pueden enviar "FACILITY_01" o "FACILITY_02", Adicionalmente si ya manejan identificadores únicos para sus sucursales, los pueden proporcionar para configurarlos en el ambiente de producción y que no deban manejar nuevos identificadores. En el caso del campo modality en nuestros servicios estan desarrollados teniendo en cuenta el estandar "DICOM" por lo tanto las modalities recibidas son las indicadas en el siguiente link: https://www.dicomlibrary.com/dicom/modality/ y se debe enviar su abreviatura ejm: "modality":"CT" para "Computed Tomography"