Class OrganizationService

Returns OrganizationService

Returns Promise<string>

A promise that resolves to a string containing a message indicating whether the organization was successfully created or if an error occurred.

// Input:
const response = await organization.create({
   basicInformation: {
      address: "123 Main Street, Hyderabad",
      state: "Telangana",
      pincode: "500001",
      contactNumber: "+919876543210"
    },
    // ... other organization fields
});
console.log(message);


// Expected Output:
"Facility added successfully. Your facility ID is IN6778"
Copy

Returns Promise<any>

Returns Promise<boolean>

• Returns:
  • true if the organization exists

// Input:
const exists = await organization.exists("accountId", "98765");
console.log(exists)


// Expected Output:
true
Copy

Returns Promise<GetOrganizationsResponse>

A promise that resolves to an object containing:

• message - Status or information message about the response (mandatory)
• data - List of organization objects or related information (mandatory)
• nextPageLink - Token to retrieve the next page of organizations (mandatory)
• totalNumberOfRecords - Total number of organizations available (optional)

// Input:
const organizations = await organization.findAll();

// Fetch next page using pagination token
const moreOrgs = await organization.findAll(organizations.nextPageLink);


// Expected output:
{
  data: [
    { id: "ORG001", organizationName: "City Hospital", ... },
    { id: "ORG002", organizationName: "Community Clinic", ... }
  ],
  nextPageLink: "someOpaqueTokenForPage2",
  message: "Successfully fetched organizations",
  totalNumberOfRecords: 200
}
Copy

Returns Promise<GetOrganizationsResponse>

A promise that resolves to:

• message: Status or informational message about the response (mandatory)
• data: Organization data associated with the given identifier (mandatory)
• nextPageLink: Pagination token if additional data exists (optional)
• totalNumberOfRecords: Total count of matching records (optional)

// Input:
const response = await organization.findById("accountId", "12345");
console.log(response)
Copy

// Expected Output:
{
  message: "Organization Found !!!",
  data: {
    id: "someInternalId",
    organizationId: "HFR-XYZ-123",
    organizationName: "Sunshine Hospital",
    basicInformation: {
      address: "123 Main Street, Hyderabad",
      state: "Telangana",
      pincode: "500001",
      contactNumber: "+919876543210"
    },
    // ... other organization fields
  },
  totalNumberOfRecords: 1
}
Copy

Returns Promise<Record<string, any>>

A promise that resolves to an array of DistrictDTO objects for the given state. If the state code is not found, returns an empty array.

// Input:
// First, fetch all states
const allStates = await organization.getStates();

// Then, extract districts for a specific state
const districts = await organization.getDistrictsByState("27", allStates);
console.log("Districts in Maharashtra:", districts);


// Expected Output:
[
  { "code": "519", "name": "Mumbai" },
  { "code": "520", "name": "Pune" },
  ...
]
Copy

Returns Promise<LocationDTO>

A promise that resolves to a LocationDTO containing geolocation data such as latitude and longitude.

// Input:
const result = await organization.getLatitudeAndLongitude("Bengaluru, India");
console.log(result.results[0].geometry.location); // { lat: ..., lng: ... }


// Expected Output:
{
  "results": [
    {
      "geometry": {
        "location": {
          "lat": 37.4224764,
          "lng": -122.0842499
        }
      },
      ...
    }
  ],
  "status": "OK"
}
Copy

Returns Promise<Record<string, any>>

A promise that resolves to an object containing:

• {string} type - The name of the master type requested.
• {Array<{code: string, value: string}>} data - List of code-value pairs under the specified master type.

// Input:
const result = await organization.getMasterData("ownership");
console.log("Ownership Types:");
result.data.forEach(item => {
  console.log(`- Code: ${item.code}, Value: ${item.value}`);
});


// Expected Output:
{
  "type": "ownership",
  "data": [
    { "code": "PVT", "value": "Private" },
    { "code": "GOV", "value": "Government" }
  ]
}
Copy

Returns Promise<Record<string, any>>

A promise that resolves with an object containing:

• {Array<{type: string, desc: string}>} masterTypes - List of available master data types.

// Input:
const masterTypes = await organization.getMasterTypes();
console.log("Available Master Data Types:");
masterTypes.masterTypes.forEach(type => {
  console.log(`- ${type.type}: ${type.desc}`);
});


// Expected Output:
{
  "masterTypes": [
    { "type": "ownership", "desc": "Facility Ownership" },
    { "type": "speciality", "desc": "Medical Specialities" }
    // ...
  ]
}
Copy

Returns Promise<Record<string, any>>

A promise that resolves to an object containing the type and an array of organization sub-type entries.

// Input:
const result = await organization.getOrganizationSubType({ code: "HOSP" });
console.log("Hospital Subtypes:");
result.data.forEach(item => console.log("- " + item.value));


// Expected Output:
{
  type: "facilitySubType",
  data: [
    { code: "GEN", value: "General Hospital" },
    { code: "SUP", value: "Super Speciality Hospital" }
  ]
}
Copy

Returns Promise<Record<string, any>>

A promise that resolves to an object containing the organization type data, or an error message if the request fails.

// Input:
const result = await orgganization.getOrganizationType("PVT");
console.log("Organization Types for Private Ownership:");
result.data.forEach(item => console.log("- " + item.value));


// Expected Output:
{
  "type": "facilityType",
  "data": [
    { "code": "HOSP", "value": "Hospital" },
    { "code": "CLIN", "value": "Clinic" }
  ]
}
Copy

Returns Promise<Record<string, any>>

A promise that resolves to an object containing the ownership subtype list.

// Input:
const result = await organization.getOwnershipSubType("GOV");
console.log("Government Ownership Subtypes:");
result.data.forEach(item => console.log("- " + item.value));


// Expected Output:
{
  type: "ownershipSubType",
  data: [
    { code: "SG", value: "State Government" },
    { code: "CG", value: "Central Government" }
  ]
}
Copy

Returns Promise<Record<string, any>>

A promise that resolves to an object containing the list of specialities.

// Input:
const specialities = await organization.getSpecialitiesForMedicine("AYUSH");
console.log("AYUSH Specialities:");
specialities.data.forEach(item => console.log("- " + item.value));


// Expected Output:
{
  type: "speciality",
  data: [
    { code: "AYUR", value: "Ayurveda" },
    { code: "YOGA", value: "Yoga & Naturopathy" }
  ]
}
Copy

Returns Promise<Record<string, any>>

A promise that resolves to an array of StateDTO objects. Each StateDTO includes:

• {string} code - The LGD code of the state.
• {string} name - The name of the state.
• {Array} districts - A list of districts belonging to the state.

// Input:
const states = await organizationService.getLgdStates();
console.log("Total states found:", states.length);
states.forEach(state => {
  console.log("- " + state.name);
});


// Expected Output:
[
  { "code": "27", "name": "MAHARASHTRA", "districts": [ ... ] },
  { "code": "29", "name": "KARNATAKA", "districts": [ ... ] },
  ...
]
Copy

Returns Promise<Record<string, any>>

A promise that resolves to a list of sub-districts, each represented as a DistrictDTO object with its own code and name.

// Input:
const puneDistrictCode = 520;
organization.getSubDistricts(puneDistrictCode)
  .then(subDistricts => {
    console.log("Sub-districts in Pune:", subDistricts);
  });


// Expected Output:
[
  { "code": "4185", "name": "Haveli" },
  { "code": "4186", "name": "Maval" },
  ...
]
Copy

Returns Promise<SearchOrganizationResponse>

• Resolves with:
• organizations - List of matched organizations.
• message - Response message.
• totalOrganizations - Total number of organizations matched.
• numberOfPages - Total pages available.

// Input:
const response = await organization.search({
  ownershipCode: "GOVT",
  stateLGDCode: "28",
  pincode: "500032",
  facilityName: "Primary Health Center",
  page: 1,
  resultsPerPage: 10
});


// Expected Output:
{
  "data": [
    {
      "organizationName": "Andheri West Clinic",
      // other fields...
    }
  ],
  "total": 1,
  "page": 1
}
Copy

Returns Promise<string>

• A promise that resolves to a success message if the update is successful.

// Input:
const response = await organization.update({
  id: "org-123",
  spocName: "Dr. Sneha",
  spocId: "spoc-001",
  consentManagerName: "Health Consent Inc.",
  consentManagerId: "cm-001"
});


// Expected Output:
"Spoc and Consent Manager added Successfully"
Copy