Skip to main content

Vacancy Check

Some programs use vacancy control, for which we provide some endpoints, depending on the type of control.

General vacancies​

Endpoint: /integration/api/v1/follow-up-patient/{followupSlug}/has-vacancy/{vacancyType}

To check if a follow-up has available vacancy, the follow-up slug and the vacancy type are required. The possible vacancy types are:

  • Quantity: limited number of vacancies
  • Period: fixed period for patient registration
  • Validity: registrations are allowed for X days after the first patient is registered

Example:

curl --location --request GET 'https://patient-care-homolog.azurefd.net/integration/api/v1/followup-up-patient/<followupSlug>/<vacancyType>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization': 'Bearer <token>'

Result:

{
  "followup": "string",
  "vacancyType": "Quantity",
  "hasVacancy": true
}

Vacancy by reference center​

Endpoint: /integration/api/v1/follow-up-patient/{followupSlug}/has-vacancy/{vacancyType/{referenceCenter}}

In addition to the type, vacancies can be segmented by Referral Centers. The parameter referenceCenter identifies the name of the reference center. The possible centers must be informed by the customer for registration in the system and can be consulted through the Reference Center endpoint.

Example:

curl --location --request GET 'https://patient-care-homolog.azurefd.net/integration/api/v1/followup-up-patient/<followupSlug>/<vacancyType>/<referenceCenter>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization': 'Bearer <token>'

Result:

{
  "followup": "string",
  "vacancyType": "Quantity",
  "hasVacancy": true
}

Vacancy by health operator​

Endpoint: /integration/api/v1/follow-up-patient/{followupSlug}/has-vacancy/{vacancyType}/{healthCareId}

Segmentation by Health Operator works in the same way as by Reference Center. The parameter healthCareId dentifies the health care provider. Possible health operators can be consulted via the Health Operators endpoint.

Example

curl --location --request GET 'https://patient-care-homolog.azurefd.net/integration/api/v1/followup-up-patient/<followupSlug>/<vacancyType>/<healthCareId>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization': 'Bearer <token>'

Result:

{
  "followup": "string",
  "vacancyType": "Quantity",
  "hasVacancy": true
}