Named Entity Recognition Grammars Package 25.2
Named Entity Recognition Grammars User Guide

# PHI Grammar Reference

The following table describes the grammar files that are available in the PHI grammar set, and the entities that each provides.

NOTE: Some entities return components, in addition to the full match. For more information, and examples, see PHI Components.

## account.ecr

Entity | Description
--- | ---
phi/account/bank/context/us | A US bank account number (including the routing number), with context. For example "Bank account no: 622356789 12345688"
phi/account/bank/nocontext/us | A US bank account number (including the routing number), without context. For example "622356789 12345688".
phi/account/bank/landmark/us | A bank account landmark, such as "Bank Account Number".
phi/account/bank/account_number/context/us | A bank account number (without routing number), with context. For example "Bank account no: 123456789".
phi/account/bank/account_number/nocontext/us | A bank account number (without routing number), without context. For example "123456789".
phi/account/bank/account_number/landmark/us | A bank account number landmark. For example "Bank account no".
phi/account/bank/routing_number/context/us | A bank routing number (without account number), with context. For example "Routing no: 622356789".
phi/account/bank/routing_number/nocontext/us | A bank routing number (without account number), without context. For example "622356789".
phi/account/bank/routing_number/landmark/us | A bank routing number landmark. For example "Routing no".
phi/account/swiftcode/context/ | A SWIFT code, with context.
phi/account/swiftcode/nocontext/ | A SWIFT code, without context.
phi/account/swiftcode/landmark/ | A SWIFT code landmark, such as "SWIFT Code".

## address.ecr

Entity | Description
--- | ---
phi/address/us | A postal address. In general, a score of one is given to an address that includes a numbered, common format street address (for example "23 North Road"), a known city (for example "London"), and a postal code in a viable format for the country (for example "SW1A 2AA"). Deviations from this form lead to score penalties. The ordering of these elements varies by country. OpenText recommends that you use prefiltering to improve the performance for this grammar. See Configure Prefiltering. Example matches: "Schlosshoferstrasse 20, 1210 Vienna", "Avenida Juan Xxiii 20, 41006, Sevilla", "Abidei Hurriyet Cd Taner Palas Han 9 Kat:7 Dayre 9, 34437 Istanbul", "162-168 Regent Street, London, W1B 5TG". This entity returns the addresses in a normalized format by default. The normalized form standardizes apartment and house numbers, expands shortened forms of region names, removes additional punctuation, and converts the text to uppercase. For example ABIDEI HURRIYET CD TANER PALAS APT 9, KAT:7, D:9, 34437 ISTANBUL. The exact order depends on the country. You can turn off normalization by setting `normalize_addresses=false` in the `address_stoplist.lua` script. This option can improve performance when you do not need normalization. This entity returns components. See PHI Components.
phi/address/landmark/us | A postal address landmark. For example "Address".
phi/address/streetlocation/context/us | A street location (house number and street name), with context. For example "Address: 123, Mill Road".
phi/address/streetlocation/nocontext/us | A street location (house number and street name), without context. For example "123, Mill Road".
phi/address/streetlocation/landmark/us | A street location landmark. For example "Address"
phi/address/city/context/us | A city or town, with context. For example "City: London".
phi/address/city/nocontext/us | A city or town, without context. For example "London".
phi/address/city/landmark/us | A city or town landmark. For example "City".
phi/address/postcode/context/us | A postal code, with context. For example "Postcode: CB4 0WZ".
phi/address/postcode/nocontext/us | A postal code, without context. For example "CB4 0WZ".
phi/address/postcode/landmark/us | A postal code landmark. For example "Postcode".
phi/address/country/context/us | A country, with context. For example "Country: United Kingdom".
phi/address/country/nocontext/us | A country, without context. For example "United Kingdom".
phi/address/country/landmark/us | A country landmark. For example "Country".

## age.ecr

Entity | Description
--- | ---
phi/age/over89/context/us | A US age statement with context. This entity finds ages over 89 years old. For example "Age: 99".
phi/age/over89/nocontext/us | A US age statement without context. This entity finds ages over 89 years old. For example "99 years old".
phi/age/landmark/us | A US age landmark. For example "Age".

## certificate.ecr

Entity | Description
--- | ---
phi/certificate/birth/context/us | A US birth certificate number with context. For example "Birth Certificate: 160 99 123456".
phi/certificate/birth/nocontext/us | A US birth certificate number without context. For example "160 99 123456".
phi/certificate/birth/landmark/us | A US birth certificate landmark. For example "Birth Certificate".
phi/certificate/generic/context/us | A US generic certificate number with context. For example "Certificate number "MX-123-456/78".
phi/certificate/generic/nocontext/us | A US generic certificate number without context. This option is available only for the certificate user extension. See Generic Certificate Numbers.
phi/certificate/generic/landmark/us | A US generic certificate landmark. For example "Certificate number".

## date.ecr

Entity | Description
--- | ---
phi/date/nocontext/eng | An English date, without context. For example, "01/13/1981". This entity returns dates in the normalized ISO-8601 format `YYYY-MM-DD`. Partial dates without a year are formatted `--MM-DD`. You can turn off normalization by setting `normalize_dates=false` in the `pii_postprocessing.lua` script. This option can improve performance when you do not need normalization.
phi/date/noyear/nocontext/eng | An English date without the year, without context. For example, "01/13"
phi/date/dob/context/eng | An English date of birth, with context. For example, "DOB: 1/13/1981".
phi/date/dob/noyear/context/eng | An English date of birth without the year, with context. For example, "DOB: 01/13".
phi/date/dob/landmark/eng | An English date of birth landmark. For example, "DOB".
phi/date/dod/context/eng | An English date of death, with context. For example, "Died on 01/13/1981".
phi/date/dod/noyear/context/eng | An English date of death without the year, with context. For example, "Died on 01/13".
phi/date/dod/landmark/eng | An English date of death landmark. For example, "Died on".
phi/date/medical/context/eng | An English medical date with context. For example, "Admission date: 01/13/1981".
phi/date/medical/noyear/context/eng | An English medical date without the year, with context. For example, "Admission date: 01/13".
phi/date/medical/landmark/eng | An English medical date landmark. For example, "Admission date".

## dea.ecr

Entity | Description
--- | ---
phi/dea/context/us | A US DEA (Drug Enforcement Agency) registration number with context. For example, "DEA Registration Number: BE1234563".
phi/dea/nocontext/us | A US DEA registration number without context. For example, "BE1234563".
phi/dea/landmark/us | A US DEA registration number landmark. For example, "DEA Registration Number".
phi/dea/ndc/context/us | A US National Drug Code (NDC) with context. For example: "NDC: 66467-2220-1".
phi/dea/ndc/nocontext/us | A US National Drug Code without context. For example: "66467-2220-1".
phi/dea/ndc/landmark/us | A US National Drug Code landmark. For example: "NDC".
phi/dea/ndc_billing/context/us | A US National Drug Code billing derivative with context. For example: "NDC: 123456-789-01".
phi/dea/ndc_billing/nocontext/us | A US National Drug Code billing derivative without context. For example: "123456-789-01".
phi/dea/ndc_billing/landmark/us | A US National Drug Code billing derivative landmark. For example: "NDC".

## device.ecr

Entity | Description
--- | ---
phi/device/udi/nocontext | A Unique Device Identifier (UDI) required by the United States FDA, as issued by the three accredited agencies, GS1, HIBCC, and ICCBA. For example: "+X999123ABC0/$$31905151234AB/S5678EDFG/16D20151001J" NOTE: To ensure that this entity performs correctly, set your `TangibleCharacters` configuration to include the following characters: `(+=`. For more information, see Configure Tangible Characters.

## healthplan.ecr

Entity | Description
--- | ---
phi/healthplan/context/us | A PHI health plan beneficiary number. These numbers consist of fourteen alphanumeric characters, preceded by a suitable landmark. For example, "Plan ID 12345678LMNOP9".
phi/healthplan/nocontext/us | A PHI health plan beneficiary number without context. For example, "12345678LMNOP9".
phi/healthplan/landmark/us | A health plan number landmark. For example, "Health Plan Number".
phi/mrn/context/us | A Medical Record Number. See Medical Record Numbers.
phi/mrn/nocontext/us | A Medical Record Number without context. This option is available only for the healthplan user extension. See Medical Record Numbers.
phi/mrn/landmark/us | A Medical Record Number landmark, such as "MRN".
phi/healthplan/npi/context/us | A US National Provider Identifier (NPI) with context. For example, "NPI: 3728482340".
phi/healthplan/npi/nocontext/us | A US National Provider Identifier without context. For example, "3728482340".
phi/healthplan/npi/landmark/us | A US National Provider Identifier landmark. For example, "NPI".
phi/healthplan/mbi/context/us | A US Medicare Beneficiary Identifier (MBI) with context. For example, "MBI: 1EG4-TE5-MK73".
phi/healthplan/mbi/nocontext/us | A US Medicare Beneficiary Identifier without context. For example, "1EG4-TE5-MK73".
phi/healthplan/mbi/landmark/us | A US Medicare Beneficiary Identifier landmark. For example, "MBI".
phi/healthplan/hicn/context/us | A US Health Insurance Claim Number (HICN) with context. For example, "HICN: 123-45-6789-A".
phi/healthplan/hicn/nocontext/us | A US Health Insurance Claim Number without context. For example, "123-45-6789-A".
phi/healthplan/hicn/landmark/us | A US Health Insurance Claim Number landmark. For example, "HICN".
phi/healthplan/hcpcs_I/context/us | A US Healthcare Common Procedure Code (HCPCS) level I with context. For example, "CPT Code 3006F".
phi/healthplan/hcpcs_I/nocontext/us | A US Healthcare Common Procedure Code level I without context. For example, "3006F".
phi/healthplan/hcpcs_I/landmark/us | A US Healthcare Common Procedure Code level I landmark. For example, "CPT Code".
phi/healthplan/hcpcs_II/context/us | A US Healthcare Common Procedure Code level II with context. For example, "Healthcare Common Procedure Code:C1300".
phi/healthplan/hcpcs_II/nocontext/us | A US Healthcare Common Procedure Code level II without context. For example, "C1300".
phi/healthplan/hcpcs_II/landmark/us | A US Healthcare Common Procedure Code level II landmark. For example, "Healthcare Common Procedure Code".

## internet.ecr

Entity | Description
--- | ---
phi/inet/email/context | An email address with context. For example, "e-mail: jsmith@mailserver.com".
phi/inet/email/nocontext | An email address without context. For example, "jsmith@mailserver.com".
phi/inet/email/landmark | An email address landmark. For example, "e-mail".
phi/inet/ip/context | An IP address with context. For example, "ip address: 5.5.5.5".
phi/inet/ip/nocontext | An IP address without context. For example, "10.12.14.16".
phi/inet/ip/landmark | An IP address landmark. For example, "ip address".
phi/inet/url/context | A URL with context. For example, "uri: https://www.example.com".
phi/inet/url/nocontext | A URL without context. For example, "www.example.com".
phi/inet/url/landmark | A URL landmark. For example, "url".

## laboratory.ecr

Entity | Description
--- | ---
phi/laboratory/context/us | A US laboratory number with context. For example "CLIA No: 01D1234567".
phi/laboratory/nocontext/us | A US laboratory number without context. For example "01D1234567".
phi/laboratory/landmark/us | A US laboratory number landmark. For example, "CLIA No".

## license.ecr

Entity | Description
--- | ---
phi/license/driving/context/us | A US driving license number with context. For example, "Driving license: 012AB3456".
phi/license/driving/nocontext/us | A US driving license number without context. For example, "012AB3456".
phi/license/driving/landmark/us | A US driving license landmark. For example, "Driving license".
phi/license/generic/context/us | A US generic license number with context. For example, "License number: MX-123-456/78".
phi/license/generic/nocontext/us | A US generic license number without context. This option is available only for the license user extension. See Generic License Numbers.
phi/license/generic/landmark/us | A US generic license landmark. For example, "License number".

## location.ecr

Entity | Description
--- | ---
phi/location/us | A US subdivision smaller than a state, such as towns, cities, and counties. For example, "Houston". Scores are boosted by the presence of a state, a zipcode, or a nearby landmark value. For example, "Houston" scores 0.4, while "Houston, Texas" scores 0.65 and "city of Houston, Texas" scores 1. State names are normalized in the results to the fullest form (for example, TX to TEXAS).

## medical_terms.ecr

Entity | Description
--- | ---
phi/medical_terms/eng | A medical condition or procedure. For example "abdominal hernia".
phi/medical_terms/blood_test/eng | A blood test. For example "9 panel urine test".
phi/medical_terms/lab_test/eng | A laboratory test. For example "1, 25 dihydroxyvitamin D".
phi/medical_terms/surgical_procedure/eng | A surgical procedure. For example "abdominal liposuction".
phi/medical_terms/specialty/eng | A medical specialty. For example "allergy and immunology".
phi/medical_terms/drug_brand/eng | A trade name for a medical drug. For example "Abelcet".
phi/medical_terms/drug_generic/eng | A generic name for a medical drug. For example "Abacavir".
phi/medical_terms/medication/eng | A medication description. For example "Altoprev tablets for oral use".
phi/medical_terms/disability/social_security/engus | An impairment for the purpose of disability evaluation under social security in the US. For example "adrenal glands carcinoma".
phi/medical_terms/disease_condition/eng | A disease or medical condition. For example "1p36 deletion syndrome".
phi/medical_terms/lifestyle/eng | A lifestyle that relates to medical conditions. For example "smoking".

## name.ecr

Entity | Description
--- | ---
phi/name/us | A full personal name, in title case or upper case. This entity returns the names in a normalized format, in the form `GIVEN NAME SURNAME`, for example JOHN SMITH. You can turn off normalization by setting `normalize_names=false` in the `names_stoplist.lua` script. You can also turn off score adjustment, by setting `rescore_names=false` in the `names_stoplist.lua` script. This option can improve performance when you do not need the normalization or score refinement. This entity returns components. See PHI Components.
phi/name/landmark/us | A full name landmark. For example "name".
phi/name/given_name/context/us | A given name, with context. For example "Forename: John".
phi/name/given_name/nocontext/us | A given name, without context. For example "John".
phi/name/given_name/landmark/us | A given name landmark. For example "Forename".
phi/name/surname/context/us | A surname with context. For example "Surname: Smith".
phi/name/surname/nocontext/us | A surname without context. For example "Smith".
phi/name/surname/landmark/us | A surname landmark. For example "Surname".
phi/name/pre_title/us | A title that precedes a name. For example "Ms".
phi/name/post_title/us | A title that follows a name. For example "Esq".
phi/name/title_surname/us | A title and surname. For example "Mr. Smith".

## national_id.ecr

Entity | Description
--- | ---
phi/id/context/us | A national identity number (US Social Security Number) with context.
phi/id/nocontext/us | A national identity number (US Social Security Number) without context.
phi/id/landmark/us | A national identity number landmark, such as "Social security number".
phi/id/redacted/context/us | A redacted or partially redacted US social security number, with context. At least one masking character, x, X, or *, must be present. For example "SSN: xxx-xx-3333".
phi/id/redacted/nocontext/us | A redacted or partially redacted US social security number, without context. At least one masking character, x, X, or *, must be present. For example "xxx-xx-3333".

## profession.ecr

Entity | Description
--- | ---
phi/profession/context/us | A profession or occupation with context.
phi/profession/nocontext/us | A profession or occupation without context.
phi/profession/landmark/us | A profession or occupation landmark.

## telephone.ecr

Entity | Description
--- | ---
phi/telephone/context/us | A telephone number with context. For example "Telephone: (201)-222-4344". NOTE: To ensure that this entity performs correctly, set your `TangibleCharacters` configuration to include the following characters: `(` `)+-`. For more information, see Configure Tangible Characters. This entity returns the telephone number in the normalized format `+NNNNN`, starting with the country code. For example +12012224344. This entity returns components. See PHI Components.
phi/telephone/nocontext/us | A telephone number without context. For example: "(204)-243-9955". NOTE: To ensure that this entity performs correctly, set your `TangibleCharacters` configuration to include the following characters: `()+-`. For more information, see Configure Tangible Characters. This entity returns the telephone number in the normalized format `+NNNNN`, starting with the country code. For example +12042439955. This entity returns components. See PHI Components.
phi/telephone/landmark/us | A telephone number landmark, such as "Tel:".

## vehicle.ecr

Entity | Description
--- | ---
phi/vehicle/licenseplate/context/us | A vehicle license place number with context. For example, "License Plate Number: ABC 123".
phi/vehicle/licenseplate/nocontext/us | A vehicle license place number without context. For example, "ABC 123".
phi/vehicle/licenseplate/landmark/us | A vehicle license plate number landmark. For example, "License Plate Number".
phi/vehicle/vin/context/ | A vehicle identification number with context. For example, "VIN: LJCPCBLCX11000237".
phi/vehicle/vin/nocontext/ | A vehicle identification number without context. For example, "LJCPCBLCX11000237".
phi/vehicle/vin/landmark/ | A vehicle identification number landmark. For example, "VIN".

Copyright 2025 Open Text
Version 25.2 | Last updated April 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Named Entity Recognition Grammars Package 25.2

Topic Title: PHI Grammar Reference