Central Registry API (1.2.0)

First Name: The first name of the user.

Last Name: The last name of the user.

Discharge User Name: The full name of the user in the clinic software platform that is performing the discharge. This will be used for auditing purposes.

Unique Site ID: An identifier that's composed of the 2-character short name for the state, and 6-digits that follow the first segment.

Central Registry ID: A unique 9-character identifier for the patient in the Central Registry. Must be exactly 9 characters long.

Identification Hash: A hash of the birthdate using the separately provided secret key, to validate that the selected patient is correct.

Important Details:

• The origin of the hash should be the patient's date of birth in ISO8601 format (YYYY-MM-DD)
• The input hash must be in hex format for proper validation
• The source method used for reference is hash_hmac() from PHP: https://www.php.net/manual/en/function.hash-hmac.php
• This is a HMAC hash, the secret key must be used to create the hash for compatibility

Actual date of discharge in ISO8601 format (YYYY-MM-DD).

• Must not be null or blank.
• Must not be in the future.
• Must not be before the admit date of this episode in the Central Registry.

Reason for discharge, represented by an integer code.

The discharge reason “Patient did not complete the admission process” may ONLY be selected if the patient has not yet received any doses of medication in this episode.

Must be one of the provided codes:

• 1 → No specific reason recorded.
• 2 → Patient successfully completed treatment.
• 3 → Patient transferred to another OTP/MAT program.
• 4 → Patient deceased.
• 5 → Unable to contact or lost contact with the patient.
• 6 → Patient left against medical advice.
• 7 → Patient was incarcerated.
• 8 → Patient lost funding or insurance.
• 9 → Patient discharged due to medical reasons or hospitalization.
• 10 → Patient was non-compliant or administratively discharged.
• 11 → Presumed dead, not yet confirmed.
• 12 → Patient did not complete the admission process (only allowed if no medication was given).
• 13 → Patient transferred due to job-related reasons.
• 14 → Discharged before converting to Lighthouse CR.
• 15 → Death due to COVID-19.
• 16 → Death due to overdose.
• 17 → Clinic permanently closed.
• 18 → Transferred to an OBOT or prescription-based program.
• 19 → Transferred to a higher level of care.
• 20 → Transferred to another incarceration facility.
• 21 → Patient was released from jail or prison.
• 22 → Unknown or not collected.
• 23 → Transferred to an outpatient program.
• 24 → Transferred to a residential program.
• 25 → Leaving mobile unit for another OTP.

Date of the last medication physically provided including take homes (YYYY-MM-DD).

• Must not be before the admit date.
• Can be after discharge date for take-home doses.
• Can not be NULL or blank.

Medication code corresponding to the final dose.

Only one medication can be selected.

If the final dose was split, list only once.

Can not be NULL or blank.

Must correspond to one of these codes:

• 1 → Methadone.
• 2 → Suboxone.
• 3 → Subutex.
• 4 → Naltrexone.
• 5 → Buprenorphine.
• 6 → Vivitrol.
• 7 → No medication given.
• 8 → Probuphine.
• 9 → Sublocade.
• 10 → Zubsolv.
• 12 → No medication administered during treatment.

Final dose provided (in milligrams).

• Must be up to 3 digits with up to 2 decimals.
• If no medication was given, this should be 0.
• If the final dose was split, provide the total amount.

Treatment Modality

Only one modality can be selected.

Optional field, if the field is provided in the payload, it cannot be set to NULL.

Must correspond to one of these codes:

• 1 → Maintenance
• 2 → Short term detox (< 30 days)
• 3 → Long term detox (< 6 months)

Patient's Step Level

Only one step level can be selected.

Optional field, if the field is provided in the payload, it cannot be set to NULL.

Must correspond to one of these codes:

• 0 → 0
• 1 → A1
• 2 → 1
• 3 → 2
• 4 → 3
• 5 → 4
• 6 → 5
• 7 → 6
• 8 → 13
• 9 → 27

Employment Type

Only one employment type can be selected.

Optional field, if the field is provided in the payload, it cannot be set to NULL.

Must correspond to one of these codes:

• 1 → Full time (35+ hours)
• 2 → Part time (regular hours)
• 3 → Part time (irregular hours)
• 4 → Student
• 5 → Military service
• 6 → Retired / disability
• 7 → Unemployed
• 8 → Controlled environment
• 9 → Homemaker

Housing Arrangements

Only one housing option can be selected.

Optional field, if the field is provided in the payload, it cannot be set to NULL.

Must correspond to one of these codes:

• owns → Owns
• dependent → Lives with someone else long term - making no payments
• rents → Rents
• transient → Transient - no permanent home address
• shelter → Shelter

Number of arrests in the past 90 days

Only one option can be selected.

Optional field, if the field is provided in the payload, it cannot be set to NULL.

Must correspond to one of these codes:

• 0 → None
• 1 → 1-2 arrests
• 2 → 3-5 arrests
• 3 → More than 5 arrests

Whether the patient has a follow-up appointment scheduled or not.

• Must be a boolean value
• Can not be NULL, but is optional

Unique Site ID: Two-character state abbreviation followed by six digits. Example: DE434055

Central Registry ID: Nine-digit identifier assigned to the patient.

Patient's Consent to Receive Text Messages

• Required if patients_cell is provided.
• Set to true to indicate current consent for SMS messaging.
• At least one of patients_cell_consent or patients_email_consent must be true.

Patients Cell Number

• Required when patients_cell_consent is true.
• Optional when consent is not provided (for example, only email consent is granted).
• Accepts digits only; no punctuation or whitespace.
• Must be exactly 10 digits and must be a valid US phone number.

Patient's Consent to Receive Email Messages

• Required if patients_email is provided.
• Set to true to indicate current consent for email messaging.
• At least one of patients_cell_consent or patients_email_consent must be true.