Criar uma ordem

Sendo uma API REST, cada método HTTP tem o significado esperado; para realizar a criação utiliza-se o método POST.

Os dados que precisam ser enviados para a criação incluem:

• Dados demográficos do paciente

• Informações sobre o estudo ou procedimento

• Informações da unidade / filial onde o estudo será realizado

• Informações sobre o médico solicitante (Opcional)

• Informação do agendamento (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.

Autorizações

Token

AuthorizationstringObrigatório

Corpo

application/json

foliostringObrigatório

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

descriptionstringObrigatório

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_identifierstringObrigatório

Unique facility identifier. Max length is 40 characters.

modalitystringObrigatório

Modality identifier. Max length is 20 characters.

prioritystringOpcional

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

extra_fieldsobjectOpcional

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_identifierstringOpcional

Room AETITLE or slug.

room_namestringOpcional

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

study_codestringObrigatório

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

study_namestringObrigatório

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

patient_identifierstringOpcional

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

patient_namestringObrigatório

Patient's names. Max length is 255 characters.

patient_first_surnamestringOpcional

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

patient_last_surnamestringOpcional

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

patient_emailstringOpcional

Patient's email. Max length is 80 characters.

patient_genderstringObrigatório

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

patient_birth_datestringObrigatório

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

patient_phone_codestringOpcional

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

patient_phone_numberstringOpcional

Patient's phone number.

physician_identifierstringOpcional

Referring physician's custom identifier.

physician_namestringOpcional

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

physician_first_surnamestringOpcional

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

physician_last_surnamestringOpcional

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

physician_emailstringOpcional

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

physician_genderstringOpcional

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

physician_phone_codestringOpcional

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

physician_phone_numberstringOpcional

Referring physician's phone number.

practitioner_assigned_emailstringOpcional

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

appointment_datestringOpcional

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

appointment_timestringOpcional

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

appointment_durationintegerOpcional

Duration of the appointment in minutes, for example 30

Respostas

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 a criação de uma ordem, o identificador da filial <facility_identifier> é exigido; em nosso ambiente de staging podem enviar "FACILITY_01" ou "FACILITY_02", Adicionalmente se vocês já utilizam identificadores únicos para suas filiais, podem fornecê-los para configurá-los no ambiente de produção e assim não precisarem usar novos identificadores. No caso do campo modality em nossos serviços estão desenvolvidos levando em conta o padrão "DICOM" portanto as modalidades recebidas são as indicadas no seguinte link: https://www.dicomlibrary.com/dicom/modality/ e deve ser enviada sua abreviatura ex.: "modality":"CT" para "Computed Tomography"