/
case_validate ()

case_validate ()

Owned by Former user (Deleted)
Function prototype

case_validate ( session, case, mode[, admission][,program][,team])

API VersionAll

Is a function to validate all the data of the case before create or update. If mode = new and there is already existent case in database function will return it's id.

Input

parameters:

  • session: is the token obtained in the session_init call
  • case: is a case XML object obtained from case_get_contact() call for example
  • mode: when case_validate was called: on creating new case (new) or on editing already existant (edit)
  • admission: (default = null) If provided then the case is edited in admission context. This means that the information provided will be validated against the FORMAT SETTINGS that correspond to the ADMISSION
  • program: (default = null) This parameter will be ignored id admission has been provided. Otherwise it will be used along with Team to find the FORMAT SETTINGS applicable to the corresponding SUBSCRIPTION). Introduced in version 2.7.12
  • team: (default = null) This parameter will be ignored id admission has been provided. Otherwise it will be used along with Program to find the FORMAT SETTINGS applicable to the corresponding SUBSCRIPTION). Introduced in version 2.7.12

Output

parameters:

  • result: Structured information about the result of the validation.
  • ErrorMsg: if there is some problem with passed identifiers or channels (they are repeated in various patients or introduced identifier is different) will be returned error message.
  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request

sample:

case_validate ( “LCAAAAAAAAA”,

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<contact>
  <ref>14693</ref> <!-- This ref may not exist for a new CASE -->
  <data>
     <bdate>AAAAMMDD</bdate>
     <gender>M|F</gender>
     <nationality_ref>ES</nationality_ref>
  </data>
  <identifiers>
    <identifier>
      <label>NICKNAME</label>
 	  <value>ALEXEY</value>
    </identifier>
    <identifier>
      <label>NAT_ES</label>
      <value>ALEXEY</value>
    </identifier>
    <identifier>
      <label>PASS</label>
      <value></value>
    </identifier>
    <identifier>
      <label>GOV_INS_ES_CAT</label>
      <value>DEV4</value>
    </identifier>
  </identifiers>
  <name>
    <prefix />
    <given_name />
    <middle_name />
    <maiden_name />
    <family_name />
    <family_name2 />
    <subfix />
  </name>
  <addresses>
    <address>
      <kind>Main Address</kind>
      <street />
      <number />
      <floor />
      <suite />
      <district />
      <city />
      <postcode />
      <state />
      <country />
      <comment />
    </address>
  </addresses>
</contact>

“, 'new');

Response

sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>
  <case_validate>
    <validation>
      <errors>
        <field>
          <id>STUDY_REF</id>
          <name>Birthdate</name>
          <error>CONTACT_FIELD.CANT_BE_NULL</error>
          <description>Can't be null</description>
        </field>
      </errors>
      <conflicts>
        <conflict>
          <name>Mary Doe</name>
          <gender>Female</gender>
          <birthdate>1968-03-12</birthdate>
          <age>52</age>
          <fields>
            <field>
              <id>CHANNEL.EMAIL</id>
              <name>e-mail</name>
              <value>marydoe@linkcare.es</value>
            </field>
          </fields>
        </conflict>
      </conflicts>
     </validation>
  </case_validate>
</result>
<ErrorMsg></ErrorMsg>

Please provide examples of the different actions that can be returned

Return Error codes

ERROR CODE

INVALID_TOKEN

The session token provided is not valid

CASE.NOT_FOUND

The CASE reference provided in XML data does not correspond to an existing USER

TEAM.NOT_FOUND

The TEAM reference provided does not correspond to a valid TEAM

PROGRAM.NOT_FOUNDThe PROGRAM reference provided does not correspond to a valid PROGRAM
CONTACT_DATA.VALIDATIONThe information provided to validate the CASE is not valid


Related content