Crisalix Api

Patients

List Patients
Create a Patient
Get a Patient
Update a Patient
Create an After
Delete a Patient

List Patients

GET /patients

Parameters

Name	Type	Default	Description
name	string		Filter patients by name
email	string		Filter patients by email
id	integer / array		Filter patients by ID
per_page	integer	10	Indicates how many records are listed per page
page	integer	1	Indicates the current page

Result

{
  "patients": [
    {
      "id": 1,
      "player_id": "1X3",
      "name": "Patient",
      "email": "patient@gmail.com",
      "height": 0,
      "weight": 0,
      "phone": "652000000",
      "gender": "female",
      "address": "Gran Via 123",
      "city": "Barcelona",
      "postal_code": "08001",
      "state": "Barcelona",
      "country_iso": "ES",
      "reconstructions": [
        {
          "type": "MammoReconstruction",
          "accepted": true,
          "status": "has_3d",
          "frames": "https://pro.crisalix.com/rec/frames.jpg",
          "mesaures": {
            "nipple_to_nipple": 22
          },
          "left": "https://pro.crisalix.com/left.jpg",
          "front": "https://pro.crisalix.com/front.jpg",
          "right": "https://pro.crisalix.com/left.jpg",
          "simulations": [
            {
              "id": 1,
              "name": "Surgery Simulation",
              "description": "",
              "frames": "https://pro.crisalix.com/sim_1234/frames.jpg",
              "left_implant": {
                "volume": "200",
                "diameter": "11.6",
                "projection": "2.8",
                "width": "0.0",
                "height": "0.0",
                "reference": "99999",
                "white": false,
                "implant_category": {
                  "name": "Smooth Soft Cohesive Low Profile",
                  "shape": "round",
                  "profile": "low",
                  "surface": "smooth",
                  "brand": {
                    "name": "Brand Name"
                  }
                }
              },
              "right_implant": {
                "volume": "200",
                "diameter": "11.6",
                "projection": "2.8",
                "width": "0.0",
                "height": "0.0",
                "reference": "99999",
                "white": false,
                "implant_category": {
                  "name": "Smooth Soft Cohesive Low Profile",
                  "shape": "round",
                  "profile": "low",
                  "surface": "smooth",
                  "brand": {
                    "name": "Brand Name"
                  }
                }
              }
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "total_pages": 2,
    "total_entries": 20
  }
}

Create a Patient

POST /patients

Parameters

Name	Type	Description
patient[name]	string	Enter the patient name
patient[email]	string	Enter the patient email
patient[gender]	string	Enter the patient gender
patient[phone]	string	Enter the patient phone
patient[country]	string	Enter the country ISO
patient[address]	string	Enter the patient address line
patient[city]	string	Enter the patient city
patient[postal_code]	string	Enter the patient zip code
patient[state]	string	Enter the patient state
reconstruction[type]	string	Enter the reconstruction type (mammo/face)
reconstruction[provider]	string	Enter the reconstruction provider (4/6) *
reconstruction[left]	file	Required if type is present. Enter the left profile image
reconstruction[front]	file	Required if type is present. Enter the portrait image
reconstruction[right]	file	Required if type is present. Enter the right profile image
reconstruction[nipple_to_nipple]	float	Required if type is present. Enter the nipple to nipple distance (mammo)
reconstruction[eye_distance]	float	Required if type is present. Enter the pupillary distance (face)

* Provider differences:

Face (provider 4): 30 seconds approx.

Head (provider 6): 30 seconds approx.

Torso (provider 4): 30 seconds approx.

Upper body (provider 6): 1 minute approx.

Result

{
  "patient": {
    "id": 1,
    "player_id": "1X3",
    "name": "Patient",
    "email": "patient@gmail.com",
    "height": 0,
    "weight": 0,
    "phone": "652000000",
    "gender": "female",
    "address": "Gran Via 123",
    "city": "Barcelona",
    "postal_code": "08001",
    "state": "Barcelona",
    "country_iso": "ES",
    "reconstructions": [
      {
        "type": "MammoReconstruction",
        "accepted": true,
        "status": "has_3d",
        "frames": "https://pro.crisalix.com/rec/frames.jpg",
        "mesaures": {
          "nipple_to_nipple": 22
        },
        "left": "https://pro.crisalix.com/left.jpg",
        "front": "https://pro.crisalix.com/front.jpg",
        "right": "https://pro.crisalix.com/left.jpg"
      }
    ]
  }
}

Get a Patient

GET /patients/:id

Result

{
  "patient": {
    "id": 1,
    "player_id": "1X3",
    "name": "Patient",
    "email": "patient@gmail.com",
    "height": 0,
    "weight": 0,
    "phone": "652000000",
    "gender": "female",
    "address": "Gran Via 123",
    "city": "Barcelona",
    "postal_code": "08001",
    "state": "Barcelona",
    "country_iso": "ES",
    "reconstructions": [
      {
        "type": "MammoReconstruction",
        "accepted": true,
        "status": "has_3d",
        "frames": "https://pro.crisalix.com/rec/frames.jpg",
        "mesaures": {
          "nipple_to_nipple": 22
        },
        "left": "https://pro.crisalix.com/left.jpg",
        "front": "https://pro.crisalix.com/front.jpg",
        "right": "https://pro.crisalix.com/left.jpg",
        "simulations": [
          {
            "id": 1,
            "name": "Surgery Simulation",
            "description": "",
            "frames": "https://pro.crisalix.com/sim_1234/frames.jpg",
            "left_implant": {
              "volume": "200",
              "diameter": "11.6",
              "projection": "2.8",
              "width": "0.0",
              "height": "0.0",
              "reference": "99999",
              "white": false,
              "implant_category": {
                "name": "Smooth Soft Cohesive Low Profile",
                "shape": "round",
                "profile": "low",
                "surface": "smooth",
                "brand": {
                  "name": "Brand Name"
                }
              }
            },
            "right_implant": {
              "volume": "200",
              "diameter": "11.6",
              "projection": "2.8",
              "width": "0.0",
              "height": "0.0",
              "reference": "99999",
              "white": false,
              "implant_category": {
                "name": "Smooth Soft Cohesive Low Profile",
                "shape": "round",
                "profile": "low",
                "surface": "smooth",
                "brand": {
                  "name": "Brand Name"
                }
              }
            }
          }
        ]
      }
    ]
  }
}

Update a Patient

PUT /patients/:id

Parameters

Name	Type	Description
patient[name]	string	Enter the patient name
patient[email]	string	Enter the patient email
patient[gender]	string	Enter the patient gender
patient[phone]	string	Enter the patient phone
patient[country]	string	Enter the country ISO
patient[address]	string	Enter the patient address line
patient[city]	string	Enter the patient city
patient[postal_code]	string	Enter the patient zip code
patient[state]	string	Enter the patient state
reconstruction[type]	string	Enter the reconstruction type (mammo/face)
reconstruction[left]	file	Enter the left profile image
reconstruction[front]	file	Enter the portrait image
reconstruction[right]	file	Enter the right profile image
reconstruction[nipple_to_nipple]	float	Enter the nipple to nipple distance (mammo)
reconstruction[eye_distance]	float	Enter the pupillary distance (face)

Note

A reconstruction can be updated if it's not accepted nor in progress.

Result

{
  "patient": {
    "id": 1,
    "player_id": "1X3",
    "name": "Changed",
    "email": "changed@email.com",
    "height": 0,
    "weight": 0,
    "phone": "652000000",
    "gender": "female",
    "address": "Gran Via 123",
    "city": "Barcelona",
    "postal_code": "08001",
    "state": "Barcelona",
    "country_iso": "ES",
    "reconstructions": [
      {
        "type": "MammoReconstruction",
        "accepted": true,
        "status": "has_3d",
        "frames": "https://pro.crisalix.com/rec/frames.jpg",
        "mesaures": {
          "nipple_to_nipple": 22
        },
        "left": "https://pro.crisalix.com/left.jpg",
        "front": "https://pro.crisalix.com/front.jpg",
        "right": "https://pro.crisalix.com/left.jpg"
      }
    ]
  }
}

Create an After

POST /patients/:id/after

Parameters

Name	Type	Description
reconstruction[type]	string	Enter the reconstruction type (mammo/face)
reconstruction[provider]	string	Enter the reconstruction provider (4/6) *
reconstruction[left]	file	Required if type is present. Enter the left profile image
reconstruction[front]	file	Required if type is present. Enter the portrait image
reconstruction[right]	file	Required if type is present. Enter the right profile image
reconstruction[nipple_to_nipple]	float	Required if type is present. Enter the nipple to nipple distance (mammo)
reconstruction[eye_distance]	float	Required if type is present. Enter the pupillary distance (face)

* Provider differences:

Face (provider 4): 30 seconds approx.

Head (provider 6): 30 seconds approx.

Torso (provider 4): 30 seconds approx.

Upper body (provider 6): 1 minute approx.

Result

{
  "after": {
    "weight": "0",
    "status": "processing",
    "accepted": "true",
    "provider": 4,
    "measures": {
      "eye_distance": 6.0,
      "ear_size": 0.0
    },
    "front": {
      "url": "https://pro.crisalix.com/front.jpg",
      "thumb": {
        "url": "https://pro.crisalix.com/thumb_front.jpg"
      }
    },
    "left": {
      "url": "https://pro.crisalix.com/left.jpg",
      "thumb": {
        "url": "https://pro.crisalix.com/thumbleft.jpg"
      }
    },
    "right": {
      "url": "https://pro.crisalix.com/right.jpg",
      "thumb": {
        "url": "https://pro.crisalix.com/thumb_right.jpg"
      }
    },
    "back": {
      "url": "https://pro.crisalix.com/back.jpg",
      "thumb": {
        "url": "https://pro.crisalix.com/thumb_back.jpg"
      }
    }
  }
}

Delete a Patient

DELETE /patients/:id

Result

{
  "result": "success"
}