API Reference

Administration

📘

Welcome to IPD!

This section will provide documentation to enable you to provide the best in-patient experience on Serenity

Create service resources

During hospitalization, patients may use resources such as beds, ventilators, oxygen or blood.
These resources
This endpoint allows you to create hospitalizations for providers on Serenity

URL: {{base_url}}/providers/{{serenity_user_provider_id}}/administration/service-resources
Method: POST

[
  {
    "name": "",
    "resource_type": "",
    "quantity_available": "",
    "location": "",
    "price": "",
    "currency": "GHS",
    "billing_type": "", // one-time, subscription
    "billing_period_type": "", // required if billing_type is "subscription"
    "billing_period_frequency": "", 
    // "bill_on": "PERIOD_START", IGNORE//
  }
]

Create a hospitalization service (ward)

This endpoint allows you to create hospitalizations for providers on Serenity

Related value sets:

  1. Service subscription frequencies: https://serenity-health.readme.io/reference/valuesets#subscription-types
  2. Wards types: https://serenity-health.readme.io/reference/valuesets#ward-types

URL: {{base_url}}/providers/{{serenity_user_provider_id}}/administration/hospitalization-services
Method: POST

{
  "name": "IPD General",
 	"description": "General hospitalizations at your favorite hospital",
  "locations": [1,2,3],
  "specialties": ["general medicine practice"],
  "service_class": "HOSPITALIZATION",
  "subscription_frequency": "", // this is from a valueset
  "ward_type": "", // this is from a valueset
  "max_capacity": 100, // maximum number of patients a hospitalization service can have at a given time
	"category": "",
  "section": "General",
  "type": "",
  "price_tiers": [
    {
      "name": "",
      "price": "",
      "currency": "",
      "description": "",
      "priority": "",
      "payment_method": "",
    }
  ]
  
}

Manage price tiers

This endpoint allows you to create hospitalizations for providers on Serenity

Related value sets:

  1. Available payers and group names: https://serenity-health.readme.io/reference/valuesets/patient-groups
[
  {
      "name": "",
      "price": "",
      "currency": "",
      "description": "",
      "priority": "",
      "payment_method": "",
    	"group_uuid": "",
    	"payment_method": "",
    }
]

URL: {{base_url}}/providers/{{serenity_user_provider_id}}/administration/price-tiers
Method: POST

📘

Important note

We've added new rules to validate billing and payments via groups. This means that both patients and price tiers can be place in to groups. Groups are a combination of payment methods and/or payers. For example, a price tier can be limited to only insurance patients - or patients of a specific insurance provider.

By default, a price tier can only be applied to a patient's bill if the groups of the patient and price tier are a match. However this can be overridden with value ofoverride_patient_group_pricingto True