Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagexml
titleJSON Schema
collapsetrue
 {

  "$schema": "http://json-schema.org/draft-04/schema#",

  "definitions": {
     "phone": {
       "type": "object",
       "properties": {

        "type": {

          "type": "string",

          "enumdescription": [

            "MOBILE",

            "LANDLINE"

 "Dictionary: PHONE_TYPE"
        ]

        },

        "number": {
           "type": "string",
           "pattern": "^\\+38[0-9]{10}$"
         }
       },
       "required": [

        "type",

        "number"
       ],
       "additionalProperties": false
     },
     "name": {
       "type": "string",
       "pattern": "^(?!.*[ЫЪЭЁыъэё@%&$^#])[a-zA-ZА-ЯҐЇІЄа-яґїіє0-9№\\\"!\\^\\*)\\]\\[(._-].*$"

    },

    "taxperson_idname": {

      "type": "string",
       "pattern": "^[1-9]([0-9]{7}|[0-9]{9})$",
(?!.*[ЫЪЭЁыъэё@%&$^#])[А-ЯҐЇІЄа-яґїіє\\'\\- ]+$",
      "minLength": 10
1,
      "maxLength": 255
    },
     "addresstax_id": {
       "type": "objectstring",
       "propertiespattern": "^[0-9]{10}$",
      "minLength": 10,
      "typemaxLength": {255
    },
    "gender": {
      "type": "string",

          "description": "Dictionary: ADDRESS_TYPEGENDER",
      "maxLength": 255
 },     },
    "countryaddress": {
      "type": "object",
      "typeproperties": "string"{
        "type": {
},          "areatype": {"string",
           "$refdescription": "#/definitions/nameDictionary: ADDRESS_TYPE"
         },
         "regioncountry": {
           "$reftype": "#/definitions/namestring"
         },
         "settlementarea": {

          "$ref": "#/definitions/name"

        },
         "settlement_typeregion": {

          "type$ref": "string#/definitions/name"

        },
         "settlement_id": {

          "type$ref": "string#/definitions/name"

        },
         "streetsettlement_type": {

          "type": "string",
         }, "description": "settlement        "street": {

          "$ref": "#/definitions/name"

        },

        "building": {

          "type": "string",

          "pattern": "^[1-9]([0-9]{1,2})?(([ \\-]{1})?(?![ЫЪЭЁыъэё])[А-ЯҐЇЄа-яґїє]{1})?((\\s)?(\\\\|\/)(\\s)?[1-9]([0-9]{1,2})?(([ \\-]{1})?(?![ЫЪЭЁыъэё])[А-ЯҐЇЄа-яґїє]{1})?)?$"

        },

        "apartment": {

          "type": "string"

        },

        "zip": {

          "type": "string",

          "pattern": "^[0-9]{5}$"

        }

      },

      "required": [

        "type",

        "country",

        "area",

        "settlement",

        "settlement_type",

        "settlement_id",

        "building"

      ],

      "additionalProperties": false

    },

    "document": {

      "type": "object",

      "properties": {

        "type": {

          "type": "string",

          "enum": [

            "PASSPORT",

            "NATIONAL_ID",

            "BIRTH_CERTIFICATE",

   type Dictionary: SETTLEMENT_TYPE"
        },
        "TEMPORARYsettlement_CERTIFICATEid",: {
          "type":  "COURT_DECISIONstring",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
         },

        "numberstreet_type": {

          "type": "string",
          "description": "street type Dictionary: STREET_TYPE"
 }        },
        "requiredstreet": {
[          "type",

        "number$ref": "#/definitions/name"
       ] },
        "additionalPropertiesbuilding": false{
     },     "type": "authentication_method": {string",
          "typepattern": "object",^[1-9]((?![ЫЪЭЁыъэё])()([А-ЯҐЇІЄа-яґїіє \\/\\'\\-0-9])){0,20}$"
       "properties": {
 },
        "typeapartment": {
           "type": "string",
           "enum": [

   },
        "OTPzip",: {
          "type":  "OFFLINEstring",
          "pattern": "^[0-9]{5}$"
         },
      },
  "phone_number": {

          "type"required": "string",[
           "pattern": "^\\+38[0-9]{10}$""type",
        "country",
}        }"area",
        "requiredsettlement": [,
         "settlement_type",
         "phonesettlement_numberid"

      ],

      "additionalProperties": false
    },
    }"document": {
  },    "type": "object",
      "properties": {
     "declaration_request   "type": {
          "type": "objectstring",
       "properties": {
   "description": "Dictionary: DOCUMENT_TYPE"
        },
        "start_datenumber": {
           "type": "string",
           "formatminLength": "date-time",

1,
         "description": "Should be defined on the client side."
        "maxLength": 255
        },

        "personissued_by": {
           "type": "objectstring",

          "propertiesminLength": 1
  {      },
        "firstissued_nameat": {
               "type": "string",
          "format": "date"
   "items": {    }
      },
      "$refrequired": [
  "#/definitions/name"      "type",
        "number"
      }],
      "additionalProperties": false
    },
    "minLengthdocument_relationship": 1{
         "type": "object",
   },   "properties":  {
        "last_nametype": {
               "type": "string",
          "description": "Dictionary: DOCUMENT_RELATIONSHIP_TYPE",
  "items": {       "minLength": 1
        },
"$ref": "#/definitions/name"       "number": {
       },     "type": "string",
          "minLength": 1

            },
             "secondissued_nameby": {
               "type": "string",

   
          "itemsminLength": {

       1
        "$ref": "#/definitions/name"},
        "issued_at": {
      },    "type": "string",
          "minLengthformat": 1
"date"
            },
      },
      "birth_daterequired": {[
        "type",
      "type":  "stringnumber",
      ],
        "formatadditionalProperties": "date"false
    },
    "authentication_method": {
  },      "type": "object",
       "birth_countryproperties": {
          "type": {
          "type": "string",

   
          "minLengthdescription": 1
"Dictionary: AUTHENTICATION_METHOD"
            },
             "birthphone_settlementnumber": {

   
          "type": "string",
          "pattern": "^\\+38[0-9]{10}$"
   "items": {    }
      },
      "$refrequired": "#/definitions/name[
        "type"
      ],
      "additionalProperties": false
    },
  },
  "type": "object",
  "properties": {
    "minLengthdeclaration_request": 1{
      "type": "object",
     }, 
   "properties": {
        "genderstart_date": {

   
          "type": "string",

 
            "enumformat": ["date-time",
          "description": "Should be defined on the client "MALEside.",
        },
        "FEMALEperson": {
          "type": "object",
  ]        "properties": {
    },              "email"first_name": {

              "type": "string",
               "format": "email"
"$ref": "#/definitions/person_name"
            },

            "taxlast_idname": {
               "type": "string",

              "items": {

                "$ref": "#/definitions/taxperson_idname"

              }

            },

            "secretsecond_name": {
               "type": "string",
              "$ref": "items": {#/definitions/person_name"
            },
            "$refbirth_date": "#/definitions/name" {
                }"type": "string",
               "minLengthformat": 6"date"
             },
             "documentsbirth_country": {
               "type": "arraystring",
               "minItemsminLength": 1,

              "itemsmaxLength": {255
            },
    "$ref": "#/definitions/document"       "birth_settlement": {
       }              },"type": "string",
              "addresses$ref": {"#/definitions/name",
               "typeminLength": "array"1,

              "itemsmaxLength": {

       255
        "$ref": "#/definitions/address"    },
           },
 "gender": {
              "minItems$ref": 2"#/definitions/gender"
             },

            "phonesemail": {

              "type": "arraystring",

              "itemsformat": {"email",
                 "$refmaxLength": "#/definitions/phone"255
            },
  }              },"tax_id": {
              "authentication_methodstype": {"string",
               "type$ref": "array",#/definitions/tax_id"
            },
            "itemsinvalid_tax_id": {

 {
              "$reftype": "#/definitions/authentication_methodboolean"
            },
  }          "secret": {
  },              "emergency_contacttype": {"string",
               "type$ref": "object#/definitions/name",
               "propertiesminLength": {6,
                 "first_name"maxLength": {20
            },
      "type": "string",     "preferred_way_communication": {
              "itemstype": {
"string",
                    "$ref"enum": "#/definitions/name"[
                   },"email",
                "phone"
   "minLength": 1          ]
       },     },
            "last_namedocuments": {
                   "type": "stringarray",
              "minItems": 1,
              "items": {


                   "$ref": "#/definitions/namedocument"
              }
            },
            "addresses": {
        "minLength      "type": 1"array",
              "items": {
    },            "$ref": "#/definitions/address"
       "second_name": {      },
              "typeminItems": "string",2
            },
      "items": {     "phones": {
               "$reftype": "#/definitions/namearray",
              "items": {
   },             "$ref": "#/definitions/phone"
     "minLength": 1          }
       },     },
            "phonesauthentication_methods": {


                 "type": "array",
                   "items": {
                     "$ref": "#/definitions/phone"

       authentication_method"
          },            }
       "minItems": 1    },
             }"emergency_contact": {
               },
"type": "object",
              "requiredproperties": [
{
                "first_name",: {
                  "last_name"type": "string",
                 "phones "$ref": "#/definitions/person_name"
               ] },
                "additionalPropertieslast_name": false{
                  },"type": "string",
               "confidant_person   "$ref": {"#/definitions/person_name"
               "type": "array", },
                "itemssecond_name": {
                  "type": "objectstring",
                  "properties$ref": {"#/definitions/person_name"
                   "relation_type": {
},
                    "typephones": "string",{
                     "enumtype": [

   "array",
                  "PRIMARYitems",: {
                    "$ref":  "SECONDARY#/definitions/phone"
                  },
  ]                "minItems": 1
  },              }
      "first_name": {       },
              "typerequired": "string", [
                "first_name",
        "items": {       "last_name",
                "$refphones":
"#/definitions/name"              ],
       },       "additionalProperties": false
            },
"minLength": 1           "confidant_person": {
       },       "type": "array",
              "last_nameitems": {
                     "type": "stringobject",

                    "itemsproperties": {
                       "$ref"relation_type": "#/definitions/name" {
                       },
"type": "string",
                    "minLengthenum": 1[
                      }"PRIMARY",
                   "second_name": {  "SECONDARY"
                   "type": "string" ]
                   },
                   "birthfirst_datename": {

                    "type": "string",
                     "format$ref": "date"
#/definitions/person_name"
                  },

                  "birthlast_countryname": {

                    "type": "string",

                    "minLength$ref": 1"#/definitions/person_name"
                   },
                   "birthsecond_settlementname": {
                     "type": "string",
                    "$ref": "items": {#/definitions/person_name"
                  },
                  "$refbirth_date": "#/definitions/name"{
                     },
"type": "string",
                    "minLengthformat": 1"date"
                   },
                   "genderbirth_country": {
                     "type": "string",
                     "enumminLength": [1
                       "MALE"},
                  "birth_settlement": {
   "FEMALE"                 "type": "string",
   ]                 "$ref": "#/definitions/name",
 },                    "tax_idminLength": {

   1
                "type": "string",    },
                  "itemsgender": {

 
                    "$ref": "#/definitions/tax_idgender"
                  },
  }                    },"tax_id": {
                    "secrettype": {
"string",
                    "type$ref": "string",#/definitions/tax_id"
                  },
                  "itemssecret": {
                       "$reftype": "#/definitions/namestring",
                     },
"$ref": "#/definitions/name",
                    "minLength": 6

                  },
                   "documents_person": {

                    "type": "array",

                    "minItems": 1,

                    "items": {

                      "$ref": "#/definitions/document"
                     }
                   },
                   "documents_relationship": {
                     "type": "array",
                     "minItems": 1,
                     "items": {

                      "$ref": "#/definitions/document_relationship"

                    }

                  },

                  "phones": {

                    "type": "array",
                     "items": {
                       "$ref": "#/definitions/phone"
                     }

                  }

                },

                "required": [

                  "relation_type",
                   "first_name",
                   "last_name",
                   "birth_date",
                   "birth_country",
                   "birth_settlement",

                  "gender",

                  "secret",
                   "documents_person",
                   "documents_relationship"
                 ],
                 "additionalProperties": false
               },
               "description": "Should be set if this Person is disabled, underage, etc."

            },

            "patient_signed": {
               "type": "boolean",

              "enum": [

                false

              ]

            },
             "process_disclosure_data_consent": {
               "type": "boolean",,
              "enum": [
                true
              ]
            }
          },
          "enumrequired": [
            "first_name",
     true       "last_name",
         ]   "birth_date",
            "birth_country",
}            }"birth_settlement",
            "required": [
gender",
            "first_namesecret",

            "last_namedocuments",

            "birth_dateaddresses",
             "birthauthentication_countrymethods",
             "birthemergency_settlementcontact",
             "genderpatient_signed",
             "secret","process_disclosure_data_consent"
             "documents"],
             "addressesadditionalProperties",

: false,
          "authentication_methodsdescription",: "Object that described a Patient. Confidant person should be set for   "emergency_contact"disabled persons, underage persons, etc."
          "patient_signed",
},
            "process_disclosure_data_consent"
employee_id": {
          ] "type": "string",
           "additionalPropertiesminLength": false36,
           "description": "ObjectEmployee thatID describedwith a Patient. Confidant person should be set for disabled persons, underage persons, etc`type=DOCTOR` selected from available Employees as a third contract party."
         },
         "employeedivision_id": {

          "type": "string",

          "minLength": 36,

          "description": "EmployeeRegistered IDMedical withService `type=DOCTOR`Provider selected from available Employees as a third contract partyDivision identifier."
         },
         "division_idscope": {
           "type": "string",
           "minLength": 36,1
        },
        "descriptionseed": "Registered Medical Service Provider Division identifier."
 {
          "type": "string"
        },
         "scopeoverlimit": {

          "type": "stringboolean",
           "enum": [
             "family_doctor"
false
          ]

        }

      },
       "required": [
         "person",
         "employee_id",
         "division_id",
         "scope"
       ],

      "additionalProperties": false

    }
   }

}


Authorize

    1. Verify the validity of access token
    2. Check user scope declaration_request:create in order to perform this action

...