Skip to content

RPN

The overview describes the common field interpretation rules, failure reasons, and full/light file formats.

Parent: rpn_result. Data from the registry of population attachment to healthcare organizations.

Fields of rpn_result.

Fields marked “Required” are always present within this object. Other fields are included when a value is available; null is excluded from the response.

Field JSON type Purpose and conditions
status string, enum Required: UNAPPROVED, PENDING, VALID, INVALID, TIMEOUT, NOT_FOUND, FAILED, ERROR_ACCEPTED, SUCCESS; see the meanings.
iin string IIN in the retrieved data.
surname string Last name.
name string First name.
second_name string Patronymic / middle name.
birth_date string Date of birth in the source's format; the schema does not validate a uniform format.
org_healthcare_code string Healthcare organization code.
org_healthcare_name string Healthcare organization name.
org_healthcare_original_id string Original healthcare organization identifier in the source.
address string Address from attachment data; not an Address technology object.
territory_sector string Territorial service area.
begin_date string Attachment start date in the source's format; the schema does not validate a uniform format.
result boolean Stored technology result: true means accepted, false means a negative result. May be absent before calculation; consider the status and the details below.
failure_reason object Failure reason, if recorded; see the structure.

The initial result may be false before data retrieval is complete. The requested IIN and the retrieved iin are not necessarily available at the same time; no separate request field is returned here.

JSON examples

Fragments of the root response object, not complete responses. All values and URLs are illustrative. File formats follow the explanations on this page.

{
  "rpn_result": {
    "status": "SUCCESS",
    "result": true,
    "iin": "000000000000",
    "org_healthcare_name": "Example healthcare organization"
  }
}