Event Payload Schema Example

BMI Calculate event payload structure (Event Payload Structure v2.0)

{
  "code": "PT.BMI.SUBMITTED",
  "journey": "BMI Details",
  "event_type": "NODE",
  "definition": {
    "version": 1.0,
    "description": "Patient submitted BMI parameters",
    "name": "PT_BMI_SUBMITTED",
    "resource": "PT_BMI_SUBMITTED",
    "type": "EVENT_DATA"
  },
  "structure": {
    "attributes": [
      {
        "code": "transactionalGuid",
        "name": "transactionalGuid",
        "required": true,
        "system": false,
        "order": 1,
        "type_definition": {
          "type": "string"
        }
      },
      {
        "code": "weight",
        "name": "weight",
        "required": true,
        "system": false,
        "order": 2,
        "type_definition": {
          "type": "number"
        }
      },
      {
        "code": "height",
        "name": "height",
        "required": true,
        "system": false,
        "order": 3,
        "type_definition": {
          "type": "number"
        }
      }
    ]
  }
}

Event Payload Structure v1.0

{
  "code": "PT.APPOINTMENT.CREATE",
  "event_type": "SELF",
  "journey": "Appointment",
  "definition": {
    "version": 4,
    "description": "Create appointment by patient",
    "name": "PT_APPOINTMENT_CREATE",
    "resource": "PT_APPOINTMENT_CREATE",
    "type": "EVENT_DATA"
  },
  "structure": {
    "attributes": [
      {
        "code": "doctorGtheId",
        "name": "doctorGtheId",
        "required": true,
        "system": false,
        "order": 1,
        "type_definition": {
          "type": "string"
        }
      },
      {
        "code": "timeSlot",
        "name": "timeSlot",
        "order": 2,
        "required": true,
        "system": false,
        "type_definition": {
          "attributes": [
            {
              "code": "from",
              "name": "from",
              "order": 1,
              "required": true,
              "system": false,
              "type_definition": {
                "type": "timestamp"
              }
            },
            {
              "code": "to",
              "name": "to",
              "order": 2,
              "required": true,
              "system": false,
              "type_definition": {
                "type": "timestamp"
              }
            }
          ],
          "type": "embedded_object"
        }
      },
      {
        "code": "appointmentType",
        "name": "appointmentType",
        "required": true,
        "system": false,
        "order": 3,
        "type_definition": {
          "attributes": [
            {
              "code": "guid",
              "name": "guid",
              "order": 1,
              "required": true,
              "system": false,
              "type_definition": {
                "type": "string"
              }
            }
          ],
          "type": "embedded_object"
        }
      }
    ]
  },
  "indexes": []
}