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

# Entities supported for the country ca

The following entities are supported for the country ca (Canada)

entity | description | example
--- | --- | ---
address | 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. 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. | 100 Boulevard Alexis-Nihon,Suite 310,Montreal,H4M 2N7,Canada 101-3485, rue de la Montagne, Montréal (Québec) H3G 2A6 1425 JAMES ST, PO BOX 4001 STN A,VICTORIA BC V8X 3X4 161 Bay Street, 27th Floor, Toronto, Ontario, M5J 2S1
address/city/context | A city or town, with context. | city: Montreal
address/city/landmark | A city or town landmark. | city
address/city/nocontext | A city or town, without context. | Montreal
address/country/context | A country, with context. | country: Canada
address/country/landmark | A country landmark. | country
address/country/nocontext | A country, without context. | Canada
address/landmark | A postal address landmark. | adresse postale
address/postcode/context | A postal code, with context. | Postcode: K2K 3C9
address/postcode/landmark | A postal code landmark. | Postcode
address/postcode/nocontext | A postal code, without context. | K2K 3C9
address/streetlocation/context | A street location (house number and street name), with context. | address: 100 Boulevard Alexis Nihon address: 100 Boulevard Alexis-Nihon,Suite 310 address: 101-3485, rue de la Montagne address: 161 Bay Street, 27th Floor address: PO BOX 4001 STN A
address/streetlocation/landmark | A street location landmark. | address
address/streetlocation/nocontext | A street location (house number and street name), without context. | 100 Boulevard Alexis Nihon 100 Boulevard Alexis-Nihon,Suite 310 101-3485, rue de la Montagne 161 Bay Street, 27th Floor PO BOX 4001 STN A
banking/account_number/context | An individual bank account number, with context. | Bank account number: 1234567
banking/account_number/landmark | An individual bank account number landmark. | Bank account number
banking/account_number/nocontext | An individual bank account number, without context. | 1234567
banking/context | Bank account numbers sufficient to identify an individual account, with context. | Bank details: 012345678 123456789123
banking/landmark | A bank account landmark. | Bank details
banking/nocontext | Bank account numbers sufficient to identify an individual account, without context. | 012345678 123456789123
banking/routing_number/context | A routing number, usually used to identify a bank branch, with context. | Routing Number: 12345-123
banking/routing_number/landmark | A routing number landmark. | Routing Number
banking/routing_number/nocontext | A routing number, usually used to identify a bank branch, without context. | 12345-123
banking/swiftcode/context | A SWIFT/BIC code, with context. | SWIFT code: XXXXCA00BBB
banking/swiftcode/nocontext | A SWIFT/BIC code, without context. | XXXXCA00BBB
driving/context | A driving license number with context. This entity matches both the driving license number, and the personal number or driver number, if present. On the standard European driving license, these are fields 5 and 4d.1 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | driver's licence: PU-BL-IJ-Q108NA
driving/landmark | A driving license landmark. | driver's licence
driving/nocontext | A driving license number, without context.2 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | PU-BL-IJ-Q108NA
health/id/context | A Canadian health insurance (card) number with context. This entity matches health ID numbers for the following healthcare schemes: Alberta Health Care Insurance Plan, BC Medical Services Plan, Manitoba Health Card, New Brunswick Medicare, Newfoundland and Labrador Medical Care Plan, Northwest Territories Health Care Plan, Nova Scotia Health Insurance Program, Nunavut Health Care Plan, Ontario Health Insurance Plan, Prince Edward Island (PEI) Health Card, Quebec Health Insurance Card, Saskatchewan Health Card, Yukon Health Care Insurance Plan, Canadian Forces, RCMP, Veteran Affairs, NSOU | BC Services Card: 9234 567 897 Health card number: 12346-6789 NWT Health Care Plan card: D1234566 New Brunswick Medicare: 123-456-782 Newfoundland and Labrador MCP: 123 456 789 015 Nova Scotia Health card: 1234 567 897 Numéro de santé Manitoba: 123 456 789 Nunavut health care number: 123456768 Ontario Health Insurance Plan: 1234-567-897-AB Prince Edward Island Health card: 12345674 Régie de l'assurance maladie Québec: ABCD 1234 5678 health card number: 0011984283 health card number: K12345678 health card number: M12345678 health card number: R12345678
health/id/context/alberta | Alberta Health Care Insurance Plan number, with context. | Alberta Health Care Insurance Plan card number: 12346-6789
health/id/context/british_columbia | BC Medical Services Plan number, with context. | BC Services Card number: 9234 567 897
health/id/context/manitoba | Manitoba Health Card number, with context. | Numéro de santé Manitoba: 123 456 789
health/id/context/new_brunswick | New Brunswick Medicare number, with context. | New Brunswick Medicare card number: 123-456-782
health/id/context/newfoundland | Newfoundland and Labrador Medical Care Plan number, with context. | Newfoundland and Labrador medical care plan card number: 123 456 789 015
health/id/context/northwest_territories | Northwest Territories Health Care Plan number, with context. | Northwest Territories Health Care Plan card number: D1234566
health/id/context/nova_scotia | Nova Scotia Health Insurance Program number, with context. | Nova Scotia Health card number: 1234 567 897
health/id/context/nunavut | Nunavut Health Care Plan number, with context. | Nunavut health care plan card number: 123456768
health/id/context/ontario | Ontario Health Insurance Plan number, with context. | Ontario Health Insurance Plan card number: 1234-567-897-AB
health/id/context/prince_edward_island | Prince Edward Island (PEI) Health Card number, with context. | Prince Edward Island Health card number: 12345674
health/id/context/quebec | Quebec Health Insurance Card number, with context. | Régie de l'assurance maladie Québec: ABCD 1234 5678
health/id/context/saskatchewan | Saskatchewan Health Card number, with context. | Saskatchewan Health card number: 123 456 789
health/id/context/yukon | Yukon Health Care Insurance Plan number, with context. | Yukon Health Care Insurance Plan card number: 123-456-782
health/id/landmark | A health number landmark. | BC Services Card Health card number NWT Health Care Plan card New Brunswick Medicare Newfoundland and Labrador MCP Nova Scotia Health card Numéro de santé Manitoba Nunavut health care number Ontario Health Insurance Plan Prince Edward Island Health card Régie de l'assurance maladie Québec health card number
health/id/nocontext | A health number, such as a British NHS number, French Carte Vitale number or Japanese Health Insurance Card number, without context. | 0011984283 123 456 789 123 456 789 015 123-456-782 1234 567 897 1234-567-897-AB 12345674 123456768 12346-6789 9234 567 897 ABCD 1234 5678 D1234566 K12345678 M12345678 R12345678
health/id/nocontext/alberta | Alberta Health Care Insurance Plan number, without context. | 12346-6789
health/id/nocontext/british_columbia | BC Medical Services Plan number, without context. | 9234 567 897
health/id/nocontext/manitoba | Manitoba Health Card number, without context. | 123 456 789
health/id/nocontext/new_brunswick | New Brunswick Medicare number, without context. | 123-456-782
health/id/nocontext/newfoundland | Newfoundland and Labrador Medical Care Plan number, without context. | 123 456 789 015
health/id/nocontext/northwest_territories | Northwest Territories Health Care Plan number, without context. | D1234566
health/id/nocontext/nova_scotia | Nova Scotia Health Insurance Program number, without context. | 1234 567 897
health/id/nocontext/nunavut | Nunavut Health Care Plan number, without context. | 123456768
health/id/nocontext/ontario | Ontario Health Insurance Plan number, without context. | 1234-567-897-AB
health/id/nocontext/prince_edward_island | Prince Edward Island (PEI) Health Card number, without context. | 12345674
health/id/nocontext/quebec | Quebec Health Insurance Card number, without context. | ABCD 1234 5678
health/id/nocontext/saskatchewan | Saskatchewan Health Card number, without context. | 123 456 789
health/id/nocontext/yukon | Yukon Health Care Insurance Plan number, without context. | 123-456-782
id/context | A national identity number with context. For information about the supported ID numbers, see Supported National ID Numbers. | Permanent resident card: RA0302123456 Social Insurance number: 159749357 indian status card: 7677566898 unique client identifier: 12-5678-9678
id/landmark | A national identity number landmark.3 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | Permanent resident card Social Insurance number indian status card unique client identifier
id/nocontext | A national identity number without context. For information about the supported ID numbers, see Supported National ID Numbers.4 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | 12-5678-9678 159749357 7677566898 RA0302123456
internet/email/context | An email address, with context. | email: jsmith@mailserver.com
internet/email/landmark | An email address landmark. | email
internet/email/nocontext | An email address, without context. | jsmith@mailserver.com
name | A full personal name. Romanized names can be in title case or upper case, and can be in the order given name surname or surname given name. CJKVT native script names must be surname given name. For Japanese, either form can include honorifics.5 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 name_stoplist.lua script. You can also turn off score adjustment, by setting rescore_names=false in the name_stoplist.lua script. This option can improve performance when you do not need the normalization or score refinement. | Dr S. Tremblay Michael Smith Régis de Descôteaux Sr Stéphanie Tremblay
name/given_name/context | A given name with context. For CJKVT the context landmark should be in CJKVT native script. | First name: Michael noms de baptême: Stéphanie
name/given_name/landmark | A given name landmark. For CJKVT it will be in native script. | First name noms de baptême
name/given_name/nocontext | A given name, without context. | Michael Stéphanie
name/landmark | A full name landmark. | nom
name/post_title | A title that follows a name. | Sr
name/pre_title | A title that precedes a name. | Dr
name/surname/context | A surname with context. For CJKVT the landmark will be in native script | Family name: Smith nom de famille: Tremblay
name/surname/landmark | A surname landmark. | Family name nom de famille
name/surname/nocontext | A surname without context. | Smith Tremblay
name/title_surname | A title and surname. | Dr Smith Dr Tremblay Dr de Tremblay
nationality/adj/context | A nationality adjective with context. | nationality: Canadian
nationality/adj/landmark | A nationality adjective landmark. | nationality
nationality/adj/nocontext | A nationality adjective without context. | Canadian
nationality/any/context | Any combination of nationality adjective and noun landmark and value. | nationality: Canadian
nationality/any/landmark | Any nationality adjective or landmark. | nationality
nationality/any/nocontext | Any nationality adjective or noun. | Canadian
nationality/noun/context | A nationality noun with context. | country: Canada
nationality/noun/landmark | A nationality noun landmark. | country
nationality/noun/nocontext | A nationality noun without context. | Canada
passport/context | A passport number with context. | passport number: LA123456
passport/landmark | A passport landmark. For information about cases where the landmark and passport number do not match or have an ambiguous match, see Ambiguous Entities. | passport number
passport/nocontext | A passport number without context. | LA123456
postcode/context | A postal code with context. | Postcode: K2K 3C9
postcode/landmark | A postal code landmark. | Postcode
postcode/nocontext | A postal code without context. | K2K 3C9
telephone/context | A telephone number with context. For the telephone_cjkvt grammar, numbers can be ASCII or full-width numbers. This entity returns the telephone number in the normalized format +NNNNN, starting with the country code. For example +12012224344.6 To ensure that this entity performs correctly, set your TangibleCharacters configuration to include the following characters: ()+-. For more information, see Configure Tangible Characters. | Numero de telephone: +1 204 243 9955 TELEPHONE: (204)-243-9955
telephone/landmark | A telephone number landmark. For the telephone_cjkvt grammar, landmarks are available only in CJKVT native script. | Numero de telephone TELEPHONE
telephone/nocontext | A telephone number without context. For the telephone_cjkvt grammar, numbers can be ASCII or full-width numbers. This entity returns the telephone number in the normalized format +NNNNN, starting with the country code. For example +12042439955.7 To ensure that this entity performs correctly, set your TangibleCharacters configuration to include the following characters: ()+-. For more information, see Configure Tangible Characters. | (204)-243-9955 +1 204 243 9955
tin/context | A tax identification number with context. For more examples, see Example Tax Identification Numbers.8 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | Tax Identification Number: 159749357
tin/landmark | A tax identification number landmark. | Tax Identification Number
tin/nocontext | A tax identification number without context. For more examples, see Example Tax Identification Numbers.9 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | 159749357
tin/vatin/context | A VAT identification number with context. | Numéro d'entreprise: 12302 6635 RC 0001 VATIN: 159749357
tin/vatin/landmark | A VAT identification number landmark. | Numéro d'entreprise VATIN
tin/vatin/nocontext | A VAT identification number without context. | 12302 6635 RC 0001 159749357

In the tables, ✔️ indicates that the item is always used, and ❌ that the item is never used. The ✓ symbol indicates that the item is only used for some entities (that is, for some but not all countries or languages). For details, refer to the relevant entity page.

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: Entities supported for the country ca