AlayaCare · Example Payload

Alayacare Medication Examples

Home CareCommunity CareHealthcareSchedulingClinicalBillingClient ManagementCare ManagementAged CareWorkforce Management

Alayacare Medication Examples is an example object payload from AlayaCare, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

InvalidRequestValidationErrorAuthChallengeMedicationCreateMedicationMedicationListMedicationSettingsMedicationSettingListMedicationSettingBranchList

Example Payload

Raw ↑
{
  "InvalidRequest": {
    "value": {
      "code": "400",
      "message": "There was a problem with your request."
    },
    "summary": "Invalid data."
  },
  "ValidationError": {
    "value": {
      "code": "409",
      "message": "Validation error.",
      "errors": []
    },
    "summary": "Conflict in the data."
  },
  "AuthChallenge": {
    "value": {
      "code": "401",
      "message": "Please verify your access level for this url."
    },
    "summary": "Authentication required."
  },
  "Medication": {
    "value": {
      "id": 1,
      "brand_name": "Name of the medication brand name",
      "name": "Medication Name",
      "administration_instructions": "Detail administration instructions",
      "administration_site_details": [],
      "administration_type": "witness",
      "cms_485_status": "new",
      "code": null,
      "count": 7,
      "create_user_id": 100,
      "created_at": "2023-01-26T15:09:40+00:00",
      "days_of_month": [],
      "discrepancy_note": "Discrepancy notes",
      "discrepancy_status": "continue",
      "discrepancy_type": "no_discrepancy",
      "dosage": "1",
      "dosage_form": "tab",
      "dosage_unit": "tab",
      "drug_family": "ophthalmic_anti_inflammatories",
      "drug_info_number": "1234",
      "duration": null,
      "duration_unit": null,
      "end_date": null,
      "end_date_unknown": false,
      "end_time": "",
      "frequency": 1,
      "frequency_max": null,
      "frequency_setting": "every_12_hours",
      "high_alert": false,
      "healthcare_professional_notified": "Healthcare profissional",
      "information_source": "organization",
      "ingredient_strength": "100",
      "ingredient_strength_unit": "mg",
      "interval": 12,
      "interval_max": 12,
      "is_archived": false,
      "is_infusion": false,
      "medication_profile_id": 1,
      "narcotic": false,
      "needs_education": true,
      "ordering_physician": "name of the doctor",
      "period": 12,
      "period_max": null,
      "period_unit": "h",
      "prn_as_needed": false,
      "prn_reason": null,
      "purpose": "The purpose of medication",
      "route": "bu_buccal",
      "start_date": "2023-01-26",
      "start_date_unknown": false,
      "start_time": "08:00",
      "status": "active",
      "status_reason": null,
      "strict": true,
      "time_of_day": null,
      "timing_notes": null,
      "timings": [
        "08:00",
        "20:00"
      ],
      "types": [
        "prescriptions"
      ],
      "update_user_id": 100,
      "updated_at": "2023-01-26T15:09:40+00:00",
      "version": 1,
      "website": null,
      "weekdays": [],
      "when": null
    }
  },
  "CreateMedication": {
    "value": {
      "brand_name": "Name of the medication brand name",
      "name": "Medication Name",
      "cms_485_status": "new",
      "count": 7,
      "days_of_month": [],
      "discrepancy_note": "Discrepancy notes",
      "discrepancy_status": "continue",
      "discrepancy_type": "no_discrepancy",
      "dosage": "1",
      "dosage_form": "tab",
      "dosage_unit": "tab",
      "drug_family": "ophthalmic_anti_inflammatories",
      "drug_info_number": "1234",
      "end_date_unknown": false,
      "end_time": "",
      "end_time_unknown": false,
      "frequency": 1,
      "frequency_setting": "every_12_hours",
      "healthcare_professional_notified": "Healthcare profissional",
      "information_source": "organization",
      "ingredient_strength": "100",
      "ingredient_strength_unit": "mg",
      "admin_timings_unknown": false,
      "administration_instructions": "Detail administration instructions",
      "administration_type": "witness",
      "interval": 12,
      "interval_max": 12,
      "max_timings_count": 2,
      "min_timings_count": 2,
      "needs_education": true,
      "ordering_physician": "Dr. Name",
      "period": 12,
      "period_unit": "h",
      "purpose": "The purpose of medication",
      "route": "bu_buccal",
      "start_date": "2023-01-26",
      "start_date_unknown": false,
      "start_time": "08:00",
      "start_time_unknown": false,
      "status": "active",
      "strict": true,
      "timings": [
        {
          "0": "08:00"
        },
        {
          "1": "20:00"
        }
      ],
      "types": [
        {
          "0": "prescriptions"
        }
      ],
      "weekdays": []
    }
  },
  "MedicationList": {
    "value": {
      "count": 1,
      "items_per_page": 10,
      "page": 1,
      "total_pages": 1,
      "items": {
        "$ref": "#/components/examples/Medication"
      }
    }
  },
  "MedicationSettings": {
    "value": {
      "name": "Setting name"
    }
  },
  "MedicationSettingList": {
    "value": {
      "count": 745,
      "items": [
        {
          "branch_id": 1000,
          "codes": [
            {
              "code": "a",
              "collection": "FHIR"
            }
          ],
          "is_enabled": true,
          "is_override": false,
          "labels": [
            {
              "default_label": "None",
              "label": "None",
              "lang": "en"
            }
          ],
          "name": "none",
          "type": "medication_administration_reason_setting"
        }
      ],
      "items_per_page": 15,
      "page": 1,
      "total_pages": 745
    }
  },
  "MedicationSettingBranchList": {
    "value": {
      "count": 745,
      "items": [
        {
          "branch_id": 1000,
          "codes": [
            {
              "code": "a",
              "collection": "FHIR"
            }
          ],
          "is_enabled": true,
          "is_override": false,
          "labels": [
            {
              "default_label": "None",
              "label": "None",
              "lang": "en"
            }
          ],
          "name": "none",
          "type": "medication_administration_reason_setting"
        }
      ],
      "items_per_page": 15,
      "page": 1,
      "total_pages": 745
    }
  }
}