These forms need precise data formats and must pass strict validations. To maximize action success and avoid failures, follow these guidelines carefully.

​
API Request Structure

To interact with Param by Logiciels Cx, your request must include the following fields:

  • integration_id: This specifies the type of response, such as filling out a medical form.
  • properties: This contains a data field, which is an array of objects representing individual form entries. A maximum of 15 data objects are recommended per request.

​
Example API Request

{
  "integration_id": "PARAM01",
  "properties": {
    "data": [
      {
        "Professional": "199270",
        "PaymentAccount": "Personal",
        "DispensationPlace": "66552",
        "ActivityArea": "1",
        "ActivityAreaAccuracy": "2",
        "PlaceAccuracy": "E",
        "WithPerson": "No",
        "People": [],
        "ReimbursementRequest": "No",
        "AuthorizationNumber": "AUTH124",
        "WorkShift": "2024-09-27 03:43",
        "Replacement": "No",
        "ReplacementDateTime": null,
        "ContextElement": null,
        "Autoline": [
          {
            "ServiceDate": "2024-09-20",
            "BillCode": "39",
            "Role": "1",
            "StartTime": "09:00",
            "EndTime": "11:30",
            "EndDate": "2024-09-19",
            "ContxElem": "1650 - Site différent",
            "PerceivedAmount": null
          }
        ]
      },
      {
        "Professional": "199270",
        "PaymentAccount": "Personal",
        "DispensationPlace": "66552",
        "ActivityArea": "1",
        "ActivityAreaAccuracy": "2",
        "PlaceAccuracy": "E",
        "WithPerson": "Yes",
        "People": [
          {
            "HIN": null,
            "RecordNumber": null,
            "PersonType": "4",
            "IDNumber": "E12345678",
            "SituationType": "2 - Enfant âgé de moins d'un an",
            "Diagnostics": "3000/CIM9",
            "EventType": "2",
            "EventDate": "2024-09-18",
            "BMI": 22.5,
            "EntryDate": "2024-09-20",
            "DepartureDate": "2024-09-19",
            "PersonDetails": {
                "FirstName": "John",
                "LastName": "Doe",
                "Sex": "Masculin",
                "BirthDate": "2000-01-01",
            },
            "AddressDetails": {
                "CivicNumber": "23408 St. John Street",
                "City": "City",
                "Province": "Province",
                "ZipCode": "V8H9H0",
            },
            "RepresentativeDetails": {
                "FirstName": "John",
                "LastName": "Doe",
                "Sex": "Masculin",
                "BirthDate": "2000-01-01",
            }
          }
        ],
        "ReimbursementRequest": "No",
        "AuthorizationNumber": "AUTH124",
        "WorkShift": "2024-09-27 03:43",
        "Replacement": "No",
        "ReplacementDateTime": null,
        "ContextElement": null,
        "Autoline": [
          {
            "ServiceDate": "2024-09-20",
            "BillCode": "39",
            "Role": "1",
            "StartTime": "09:00",
            "EndTime": "11:30",
            "EndDate": "2024-09-19",
            "ContxElem": "1650 - Site différent",
            "PerceivedAmount": null
          }
        ]
      }
    ]
  }
}

​
Data Format Guidelines

Each object within the data field must follow a specific schema, depending on the form you’re filling out. Below are some examples of the types of data you may need to include.

​
Entry Type: With Person

​
Example: With HIN (Health Identification Number)

For cases where a person has a HIN, you should include detailed medical and event data. Here’s the schema for an entry with HIN:

{
  "Professional": "199270",
  "PaymentAccount": "Personal",
  "DispensationPlace": "66552",
  "ActivityArea": "1",
  "ActivityAreaAccuracy": "2",
  "PlaceAccuracy": "E",
  "WithPerson": "Yes",
  "People": [
    {
      "HIN": "AARA88112710",
      "RecordNumber": null,
      "PersonType": null,
      "IDNumber": null,
      "SituationType": "10",
      "Diagnostics": "3000/CIM9",
      "EventType": "2",
      "EventDate": "2024-09-18",
      "BMI": 22.5,
      "EntryDate": "2024-09-18",
      "DepartureDate": "2024-09-19"
    },
  ],
  "ReimbursementRequest": "Yes",
  "AuthorizationNumber": "AUTH123",
  "WorkShift": "2024-09-27 03:43",
  "Replacement": "Yes",
  "ReplacementDateTime": "2024-09-27 03:43",
  "ContextElement": "0110 - Remplaçant au cours d'une anesthésie",
  "Autoline": [
    {
      "ServiceDate": "2024-09-29",
      "BillCode": 394,
      "Role": 1,
      "StartTime": "08:00",
      "EndTime": "10:00",
      "EndDate": "2024-09-29",
      "ContxElem": "1650 - Site différent",
      "PerceivedAmount": 150.0
    },
  ]
}

​
Example: Without HIN

For entries where a person does not have a HIN, the RecordNumber or other identifying information should be provided. Example schema:

{
  "Professional": "199270",
  "PaymentAccount": "Personal",
  "DispensationPlace": "66552",
  "ActivityArea": "1",
  "ActivityAreaAccuracy": "2",
  "PlaceAccuracy": "E",
  "WithPerson": "Yes",
  "People": [
    {
      "HIN": null,
      "RecordNumber": "EFHVFD14",
      "PersonType": null,
      "IDNumber": null,
      "SituationType": "9 - Dans le cadre d'une demande de remboursement à remettre au patient",
      "Diagnostics": "3042/CIM9",
      "EventType": "1 - Service rendu dans le cadre des lois relatives à la santé et à la sécurité du travail",
      "EventDate": "2024-09-18",
      "BMI": 22.5,
      "EntryDate": "2024-09-11",
      "DepartureDate": "2024-09-19",
      "PersonDetails": {
        "FirstName": "John",
        "LastName": "Doe",
        "Sex": "Masculin",
        "BirthDate": "2000-01-01"
      },
      "AddressDetails": {
        "CivicNumber": "23408 St. John Street",
        "City": "City",
        "Province": "Province",
        "ZipCode": "V8H9H0"
      },
      "RepresentativeDetails": {
        "HIN": "AARA88112710"
      }
    },
  ],
  "ReimbursementRequest": "Yes",
  "AuthorizationNumber": "AUTH123",
  "WorkShift": "2024-09-27 03:43",
  "Replacement": "Yes",
  "ReplacementDateTime": "2024-09-27 03:43",
  "ContextElement": "0110 - Remplaçant au cours d'une anesthésie",
  "Autoline": [
    {
      "ServiceDate": "2024-09-29",
      "BillCode": 394,
      "Role": 1,
      "StartTime": "08:00",
      "EndTime": "10:00",
      "EndDate": "2024-09-29",
      "ContxElem": "1650 - Site différent",
      "PerceivedAmount": 150.0
    },
  ]
}

​
Example: Without HIN and RecordNumber

For entries where a person does not have a HIN and RecordNumber identifying information like PersonType and IDNumber should be provided. Example schema:

{
  "Professional": "199270",
  "PaymentAccount": "Personal",
  "DispensationPlace": "66552",
  "ActivityArea": "1",
  "ActivityAreaAccuracy": "2",
  "PlaceAccuracy": "E",
  "WithPerson": "Yes",
  "People": [
    {
      "HIN": null,
      "RecordNumber": null,
      "PersonType": "4 - Externe",
      "IDNumber": "E12345678",
      "SituationType": null,
      "Diagnostics": null,
      "EventType": null,
      "EventDate": null,
      "BMI": null,
      "EntryDate": null,
      "DepartureDate": null
    }
  ],
  "ReimbursementRequest": "Yes",
  "AuthorizationNumber": "AUTH123",
  "WorkShift": "2024-09-27 03:43",
  "Replacement": "Yes",
  "ReplacementDateTime": "2024-09-27 03:43",
  "ContextElement": "0110 - Remplaçant au cours d'une anesthésie",
  "Autoline": [
    {
      "ServiceDate": "2024-09-29",
      "BillCode": 394,
      "Role": 1,
      "StartTime": "08:00",
      "EndTime": "10:00",
      "EndDate": "2024-09-29",
      "ContxElem": "1650 - Site différent",
      "PerceivedAmount": 150.0
    },
  ]
}

​
Entry Type: Without Person

​
Example

If no person is involved in the form, the People field should be left as an empty array, like this:

{
  "Professional": "199270",
  "PaymentAccount": "Personal",
  "DispensationPlace": "66552",
  "ActivityArea": "1",
  "ActivityAreaAccuracy": "2",
  "PlaceAccuracy": "E",
  "WithPerson": "No",
  "People": [],
  "ReimbursementRequest": "Yes",
  "AuthorizationNumber": "AUTH123",
  "WorkShift": "2024-09-27 03:43",
  "Replacement": "Yes",
  "ReplacementDateTime": "2024-09-27 03:43",
  "ContextElement": "0110 - Remplaçant au cours d'une anesthésie",
  "Autoline": [
    {
      "ServiceDate": "2024-09-29",
      "BillCode": 394,
      "Role": 1,
      "StartTime": "08:00",
      "EndTime": "10:00",
      "EndDate": "2024-09-29",
      "ContxElem": "1650 - Site différent",
      "PerceivedAmount": 150.0
    }
  ]
}

​
Entry Type: With Multiple Autoline Records

​
Example

Multiple Autoline can be provided for a single entry, like this:

{
  "Professional": "199270",
  "PaymentAccount": "Personal",
  "DispensationPlace": "66552",
  "ActivityArea": "1",
  "ActivityAreaAccuracy": "2",
  "PlaceAccuracy": "E",
  "WithPerson": "No",
  "People": [],
  "ReimbursementRequest": "Yes",
  "AuthorizationNumber": "AUTH123",
  "WorkShift": "2024-09-27 03:43",
  "Replacement": "Yes",
  "ReplacementDateTime": "2024-09-27 03:43",
  "ContextElement": "0110 - Remplaçant au cours d'une anesthésie",
  "Autoline": [
    {
      "ServiceDate": "2024-09-29",
      "BillCode": 394,
      "Role": 1,
      "StartTime": "08:00",
      "EndTime": "10:00",
      "EndDate": "2024-09-29",
      "ContxElem": "1650 - Site différent",
      "PerceivedAmount": 150.0
    },
    {
      "ServiceDate": "2024-09-18",
      "BillCode": 394,
      "Role": 1,
      "StartTime": "08:00",
      "EndTime": "10:00",
      "EndDate": "2024-09-19",
      "ContxElem": "1650 - Site différent",
      "PerceivedAmount": 150.0,
      "ProfessionalInReference": {
        "Type": "1 - Professionnel référent",
        "ReferentNumber": "105251",
        "LastName": "Doe",
        "FirstName": "John",
        "ProfType": "1 - Médecin",
        "Territory": "1 - Québec"
      }

    }
  ]
}

​
Validation and Rejection of Entries

If your request contains more than 15 objects in the data array, the request will fail, and the rejected entries will be returned in the data.properties.failed field of the response. Make sure to limit your requests to 15 objects per submission.

Ensure all data follows the correct format and passes the validations required by the Param medical system. Incorrect data or formats will result in rejected requests.

By following these guidelines, you ensure that your API requests for the Param integration meet all the necessary standards and validations required by medical service websites.

Was this page helpful?

Available IntegrationsOffice Ally Guide