Developer documentation‎ > ‎FHIR API‎ > ‎Terminology‎ > ‎

Naming Systems

This is a draft document. Please be aware that the contents are subject to change.

Identifier Systems

When assigning a business identifier to a resource, such as a Patient, it is important to identify the namespace ("system") from which that identifier was drawn. The system is indicated by setting the relevant value into Identifer.system.

So what is the relevant value? Well, it depends on where the identifier came from.

Externally Defined

FHIR curates a list of officially supported systems, along with the system value which should be used.

Other externally defined systems exist, and these may define their own system identifier which should be used. For example, the NHS defines as the system to be used when providing NHS Numbers.

PKB has no control over the system values defined externally. They are not required to be resolvable, and if they do resolve the content returned is undefined.

Externally Defined, PKB Hosted

PKB allows customers to define their own local identifier types at the level of both a PKB Organisation and also a PKB Team. In these cases, PKB is hosting information about the identifier types, but is not responsible for the identifiers. Note: this is not to say all the attributes of the identifier type are meaningful outside of PKB. For example, whilst a customer might configure a display name for the identifier type to match that used in their own internal systems, it is possible that they might have configured an Assigning Authority / Type Code for use in HL7 messages which is only correct for messages sent to PKB.

Each of these local, customer-specific identifier types is assigned a UUID by PKB.

This UUID is converted into a system for use in a FHIR Identifier by simply prepending it with "urn:uuid:" such that the UUID becomes a valid URI.

Note: this same UUID also acts as the resource id for NamingSystem, but this is merely an implementation detail. Callers should not depend on this remaining true.

PKB does not expose information about a customer's local identifier types to anyone other than the customer. As such, there is no plan to replace the UUID-based URIs with resolvable URLs, since anyone who needs to understand the system will already do so.

PKB Defined

Identifiers assigned by PKB are typically exposed directly through resource IDs.

As such, there are no PKB-defined identifiers which are exposed as FHIR business identifiers, although this could conceivably change in the future.