Create an iframe Case

Description

Adds a new planner case to the IBRA database, and creates and returns a unique case ID (case_id) of this case if you haven't provided a unique case ID with the request. This ID is needed when working with the laser and IOL treatment planners (iframe).

Background
For security reasons only miminal data is transmitted via GET statements (e.g. only a token or a case_id). For handling more sensitive data from an external EMR or DHS system we use specific cases that serve as data distribution storages. Once submitted, the iframe treatment planners can read the provided data and can use it for the calculations. Missing parameters collected in the planners, and the treatment decisions, are also stored in these cases and can be returned to the host application (bilateral data transfer).

URL

POST https://www.zubisoft.com/api/planner_case

Permission

Standard authentication with public key, hashed private key and user key is required.
Resource must be enabled for the requesting user (defined by the subscription plan on customer account level).

Parameters
The following parameters are required. Please use exact naming as provided in the comment column.
Field Format Description (Allowed Range)
age Integer 28
eye String R or L
case_id String A unique case ID (max. length of 45 characters). If you don't submit one the resource will create and return one for you.
manifest_sphere_pre Float Pre-operational sphere (-25 to 25)
manifest_cylinder_pre Float Pre-operational cylinder (-20 to 20)
manifest_axis_pre Integer Pre-operational axis (-180 to 180)
method String Supported methods:
  • LASIK
  • PRK
  • Trans-PRK
  • LASEK
  • Lenticule Extraction
laser Integer Supported Laser (submit only the ID of the laser):
  • ID=1 (Alcon WaveLight Allegretto)
  • ID=2 (Alcon WaveLight Eye-Q)
  • ID=3 (Alcon WaveLight EX500)
  • ID=6 (Johnson & Johnson VISX S4)
  • ID=8 (Ziemer Aquariuz)
  • ID=9 (Ziemer LDV)
  • ID=10 (Schwind Amaris 500E)
  • ID=11 (Schwind Amaris 750S)
  • ID=12 (Schwind Amaris 1050RS)
  • ID=13 (Schwind ATOS)
  • ID=15 (ZEISS Mel 80)
  • ID=16 (ZEISS Mel 90)
  • ID=17 (ZEISS VisuMax)
  • ID=19 (Bausch Technolas 217)
  • ID=21 (NIDEK EC-5000)
laser_mode String Supported laser modes (overview, use exact wording):
  • Alcon lasers: WFO, CONTOURA, Topography guided, Wavefront guided
  • VISX lasers: Conventional, Wavefront WaveScan, Wavefront iDesign
  • Schwind lasers: Aspheric aberration-free, Corneal wavefront, Ocular wavefront
  • ZEISS excimer lasers: Aspheric
  • ZEISS femto laser: SMILE
  • Bausch Technolas laser: Aspheric
  • NIDEK laser: Aspheric
laser_optical_zone Float 1 to 10
flap_thickness Float 0 to 300
pachymetry_central_pre Float 200 to 800
topo0_cylinder Float Measured Topo-Cylinder, for CONTOURA treatments only (-20 to 20)
topo0_axis Integer Measured Topo-Axis, for CONTOURA treatments only (-180 to 180)
target_sphere Float -20 to 20
target_cylinder Float -15 to 15
Field Format Description (Allowed Range)
eye String R or L
case_id String A unique case ID. If you don't submit one the resource will create and return one for you.
axial_length Float 15 to 39
anterior_chamber_depth Float 0 to 6
k_flat_pre Float 20 to 70
k_steep_pre Float 20 to 70
k_steep_axis_pre Integer -180 to 180
topography_cylinder_pre Float Optional, range: -20 to 20
topography_axis_pre Integer Optional, range:-180 to 180
iol Integer Optional, can be selected in the planner, supported IOLs (submit only the ID, full list of IDs: see devices), e.g.
  • ID=80 (Alcon AcrySof PanOptix TFNT00)
  • ID=392 (HOYA Vivinex XC1-SP)
 

{
	"age": "28",
    "eye": "L",
	"case_id":"kilx542aSege",
	"manifest_sphere_pre":-6,
	"manifest_cylinder_pre": -1.25,
	"manifest_axis_pre": 90,
	"method": "LASIK",
	"laser": 1,
	"laser_mode": "WFO",
	"intervention": "first",
	"laser_optical_zone": 6,
    "flap_thickness": 225,
    "pachymetry_central_pre": 438,
	"target_sphere": 0,
	"target_cylinder": 0
}



{
    "eye": "L",
	"case_id":"kilx542aSege",
	"axial_length": 23.74,
	"anterior_chamber_depth": 2.94,
	"k_flat_pre": 43.11,
	"k_steep_pre": 44.78,
	"k_steep_axis_pre": 84
}


curl --location --request POST 'https://www.zubisoft.com/api/planner_case' \
--header 'X-Private-Key: hashOfYourPrivateKey' \
--header 'X-Public-Key: yourPublicKey' \
--header 'X-User-Key: yourUserKey' \
--header 'Content-Type: application/json' \
--data-raw '{
	"age": 2021,
	"manifest_sphere_pre": -2.25,
	"manifest_cylinder_pre": 0,
	"manifest_axis_pre": 0,
	"method": "LASIK",
	"laser": 3,
	"laser_mode": "WFO",
	"laser_optical_zone": 6.5,
	"target_sphere": 0,
	"target_cylinder": 0,
	"flap_thickness": null,
	"pachymetry_central_pre": null
}'



curl --location --request POST 'https://www.zubisoft.com/api/planner_case' \
--header 'X-Private-Key: hashOfYourPrivateKey' \
--header 'X-Public-Key: yourPublicKey' \
--header 'X-User-Key: yourUserKey' \
--header 'Content-Type: application/json' \
--data-raw '{
    "eye": "L",
	"case_id":"kilx542aSege",
	"axial_length": 23.74,
	"anterior_chamber_depth": 2.94,
	"k_flat_pre": 43.11,
	"k_steep_pre": 44.78,
	"k_steep_axis_pre": 84

}'
Response
The response includes the following values:
Name Format Example Comment
case_id String kilx542aSege This is the unique case ID you submitted, or a new unique case ID we generated for you. 

{
    "case_id": "kilx542aSege"
}