Creating a Code System

Creating Code Systems are managed by the controls above the Code Systems table

🚧To create a new Code System, please follow the steps below:

1

Open the Create Code System View

Creating a Code System is started by clicking the Add button above the Code System table

🚧To open the Create Code Systems view:

  • Click the Create button

After, the Create Code System view will display

2

Define the Name

The Name is a short, descriptive, human readable name for the code system.

🚧To define the Name for the Code System:

  • Enter a Name into the Name input

Examples

  • ISO3166-2 Alpha Country Codes would be a good name for the domain ISO3166-2

  • LOINC would be a good name for the domain LN

  • HL7v2 Administrative Sex would be a good name for the domain V2AdministrativeGender

3

Define the Domain

The Domain is a unique short name for the code system.

In HL7v2, this is the CX.4 portion of the code — example: CODE^^^DOMAIN.

It is also the short name that appears within internal HDSI view model payloads.

🚧To define the Domain for the Code System:

  • Enter a Domain into the Domain input

Examples

  • ISO3166-2 would be a domain for the name ISO3166-2 Alpha Country Codes

  • LN would be a good domain for the name LOINC

  • V2AdministrativeGender would be a good domain for the name HL7v2 Administrative Sex

4

Define the OID

An OID is a universally unique identifier for the code system.

This is used in HL7v2 in the CX.4.3 portion of a code such as CODE^^^&2.25.XXXXXX&ISO and in HL7v3/CDA based transactions.

This should be one of:

  • An IANA Private Enterprise Number based OID

  • An HL7 Registered OID

  • A UUID expressed as 2.25.XXXXXXX

🚧To define the OID for the Code System:

  • Enter a OID into the OID input

5

Define the URL

The URL is a unique resource locator to the definition of the terminology.

This is typically used on HL7 FHIR interfaces

🚧To define the URL for the Code System:

  • Enter a URL into the URL input

6

Define the Version

The Version is the exact version of the terminology being imported or expressed by the code system.

🚧To define the Version for the Code System:

  • Enter a Version into the Version input

7

Define the Description

The Description is a description the what the Code System is and its intended use case — or any other relevant information about it

🚧To define the Description for the Code System:

  • Enter a Description into the Description input

8

Save

Once the administrator has completed the necessary fields, this step will commit the new Code System into the application.

🚧To save the new Code System in the application:

  • Click the Save button

After, you should be directed to the Edit Code System View.

Please see the Editing a Code System guide for more information.

PreviousCode SystemsNextEditing a Code System

Last updated