Editing an Identity Domain

The Edit Identity Domain view allows you to see and modify the settings/configurations for a selected Identity Domain

Panels in the Edit View

Identity Domain Properties Panel

This panel defines the basic properties about the Identity Domain

Property
Editable
Description

UUID

❌

This is the unique identifier assigned and used by the system to keep track of the Identity Domain record

Namespace ID

✅

This is specialized ID of the Identity Domain. The namespace identifier is used in the HDSI and HL7v2 to identify the identifiers. These must be unique in the system.

Universal ID

✅

This is Universal ID of the Identity Domain that most systems will share. The object identifier of the identity domain is used by HL7v3 messages and HL7v2 messages to tag an identifier with the identity domain to which the identity domain belongs.

URL

✅

This is the URL for this Identity Domain. URLs are used by FHIR for correlating the Identity Domain with the identifier when FHIR Messages are received

Name

✅

This is the display, or the human readable name of the Identity Domain

Classification

✅

This is the general classification which identifiers assigned to this Identity Domain carry, or regard.

Created By

❌

This is the User who created this Identity Domain and date and time when it was created

Validation Panel

This panel defines the validation properties for an Identity Domain

Property
Description

Validation Regex

This is a value used to validate values carried out through this Identity Domain.

Check Digit Type

If the identifier uses a separate check digit in the check digit field (or required generation), select the check digit algorithm to be used

Cusom Format Validator

If the identifiers in this identity domain have a specialized format (for example, check digits or computational generation) select the implementation of the validation here.

Authority and Scope Panel

This panel defines the Authority and Scope properties regarding entities and policies related to an Identity Domain

Property
Description

Scope

This is the entity this Scope is regarding

Disclosure Policy

This is the Policy that this Authority has with the system.

Assigning Authority Panel

This panel defines the Assigning Authorities regarding applications and flags for Identifiers

Property
Description

Application

This is the application that this Assigning Authority is using or regarding

Is Authoritative Source

This checkbox indicates if the flag is authoritative or informative

✏️How to Edit an Identity Domain?

Editing an Identity Domain in the system can be done by following the steps in this guide

1

Navigate to the Identity Domain Edit View

  • Navigate to the Reference Data -> Identity Domains view

  • Click on the Edit button in the Actions column

After, you should be redirected to the Edit Identity Domain Form

2

Update the Identity Domain Properties

  • Locate the Identity Domain Properties Panel

  • Update the Namespace ID in the Namespace ID input

Namespace ID

This is specialized ID of the Identity Domain.

Use of Namespace ID

The namespace identifier is used in the HDSI and HL7v2 to identify the identifiers. These must be unique in the system.

Format

The Namespace ID must only contain

  • 🔠letters (A to Z and a to z),

  • 🔢numbers(0 to 9), and

  • 🔣some special characters (-, _)

💼Examples

  • GS1 Global Trade Identification Number (GTIN) — 1.3.160

  • ISO-3166 Country Identifiers — 1.0.3166.1.2.3

  • LMIS Item Code ID — 1.3.6.1.4.1.52820.5.4.4.2

  • Update the Universal ID in the Universal ID input

Universal ID

This is Universal ID of the Identity Domain that most systems will share.

Use of Universal ID

The object identifier of the identity domain is used by HL7v3 messages and HL7v2 messages to tag an identifier with the identity domain to which the identity domain belongs.

Format

The Universal ID must only contain numbers(0 to 9) and decimals (.)

These should be:

  • An IANA Private Enterprise Number

  • An HL7 Registered Assigning Authority

  • A UUID in format 2.25.XXXX

💼Examples

  • GS1 Global Trade Identification Number (GTIN) — 1.3.160

  • ISO-3166 Country Identifiers — 1.0.3166.1.2.3

  • LMIS Item Code ID — 1.3.6.1.4.1.52820.5.4.4.2

  • Update the URL in the URL input

URL

This is the URL for this Identity Domain.

Use of URL

URLs are used by FHIR for correlating the Identity Domain with the identifier when FHIR Messages are received

Format

The formula for a URL — <protocol>+ <hostname> + <path> + <query> + <fragment>, can be broken down into the following:

  • — protocol used to communicate with endpoint https://

  • — domain name example.com

  • — path to a resource /page

  • — ⭐(Optional) query parameters ?id=123

  • — ⭐(Optional) a fragment or anchor #section

  • Update the Name in the Name input

Name

This is the display, or the human readable name of the Identity Domain

Format

The Name can contain the following:

  • 🔠letters (A to Z and a to z),

  • 🔢numbers(0 to 9), and

  • 🔣any special characters (-, _, etc..)

  • ⭐(Optional) Select the Classification in the Classification select input

Classification

This is the general classification which identifiers assigned to this Identity Domain carry, or regard.

You may only specify 0 or 1 Classification for 1 Identity Domain

3

Edit the Validation Properties

  • Locate the Validation Panel

  • ⭐(Optional) Update the Regular Expression in the Validation Regex input

Regular Expression

This is a value used to validate values carried out through this Identity Domain.

Use of Regular Expression

Use this field to specify the format of the identifier (the pattern that conformant identifiers need to have)

💼Example

  • ^\d{12,14}$ — starts and ends with only 12 to 14 numbers/digits (e.g. 123456789000, 1234567890000, 12345678900000)

🔣Format/Syntax for Regular Expressions

Format

The format for the Regular Expression input is simple if you are familiar with regular expression in other software interfaces.

Syntax

Here is a few syntax examples to get you started:

Positioning

  • match for start or end of a string

    • ^ — start of a line or string

      • This must be used at the beginning of the regular expression to work

    • $ — end of a line or string

      • This must be used at the end of the regular expression to work

Characters

  • common characters:

    • \d — digit (0-9)

    • \w — word character (letters, digits, or underscores)

    • \s — all whitespace characters (e.g. any of these characters [ \t\r\n\f\v])

    • \S — all non-whitespace characters (e.g. anything but these characters [^ \t\r\n\f\v])

    • \t — tab character

Sets

  • character sets:

    • [A-Z] — all capital letters

    • [a-z] — all lowercase letters

    • [0-9] — all digits

Ranges

  • exact or range of characters from a set or one individual character

    • + — (i.e. 1 or more)

    • * — (i.e. 0 or more)

    • ? — (i.e. 0 or 1)

    • {<start>,<end>} — min and max of character or set

      • {1,} — 1 to infinity

      • {2,4} — 2 to 4

      • {,5} — 0 to 5

  • ⭐(Optional) Select the Check Digit Format from the Check Digit Type select input

Check Digit Type

If the identifier uses a separate check digit in the check digit field (or required generation), select the check digit algorithm to be used

Available Options

  • None

  • ISO/IEC-7064 MOD-97,10

  • Custom MOD-97 Based Algorithm

  • ⭐(Optional) Select the Custom Format Validation from the Custom Format Validator select input

Custom Format Validator

If the identifiers in this identity domain have a specialized format (for example, check digits or computational generation) select the implementation of the validation here.

Available Options

  • None

  • ISO/IEC-7064 MOD-97,10

  • Custom MOD-97 Based Algorithm

  • ⭐(Optional) Check the Unique checkbox input if this is considered a Unique validation

4

Update the Authentication and Scope Properties

  • Locate the Authentication and Scope Panel

  • ⭐(Optional) Search and select any valid Scopes in the Scopes search input

Scope

Scope is the entity this Identity Domain is regarding

💼Examples

  • 💊Material

  • ©️💊Manufactured Material

  • etc...

  • ⭐(Optional) Select a desired Disclosure Policy in the Disclosure Policy select input

Disclosure Policy

Disclosure Policy regards the Policy that this Authority has with the system.

This is similar to Policies that are applied with Devices, Applications, Groups, etc...

💼Examples

  • Alter Role Policy

  • OAUTH Policies

  • Clinical Data Policies

5

Update the Assigning Authority Properties

  • Locate the Assigning Authority Panel

  • ⭐(Optional) Select a desired Application in the Application select input

Application

  • Whenever an identifier in this domain is registered from this application — it can be flagged as authoritative or informative.

  • ‼️You may restrict the ability of non-authoritative applications from issuing new identifiers — which will result in a data quality warning

  • ⭐(Optional) Check the Authoritative Source checkbox if you consider this to be an Authoritative Source

Authoritative Source

This checkbox indicates if the flag is authoritative or informative

  • ⭐(Optional) Add more Assigning Authority Applications by clicking the Add button and repeating the last step until you have all possible Applications accounted for

6

Save Edits

Finally, click the Save button at the bottom of the form to Save the new Identity Domain

PreviousAdding a New Identity DomainNextRemoving an Identity Domain

Last updated