Skip to content

Main content

FHIR Coding Version Display Pair Tool

Build a version-aware identity tuple for a supplied FHIR Coding; display text is not used as code identity.

Loading tool…

Description

Return a JSON-array identityKey of system, version, and code, and independent nonempty version and display flags.

Clinical identifiers and references have a namespace, target, and sometimes a version or contained-resource scope. Parsing their spelling does not resolve the target or establish semantic identity.

Return a JSON-array identityKey of system, version, and code, and independent nonempty version and display flags.

When to use this tool

Use FHIR Coding Version Display Pair when you need one supported clinical-reference or scoped-identifier component.

How to use the tool and how it works

  1. Enter system, code, version, display. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read identityKey, hasVersion, hasDisplay. Inspect hasVersion, hasDisplay before interpreting the associated values.

Require nonempty system and code. Return a JSON-array identityKey of system, version, and code, and independent nonempty version and display flags.1

Input fieldMeaning and unitsAccepted input
systemSystemRequired. Text; maximum UTF-16 length 8192.
codeCodeRequired. Text; maximum UTF-16 length 8192.
versionVersionRequired. Text; maximum UTF-16 length 8192.
displayDisplayRequired. Text; maximum UTF-16 length 8192.
Output fieldInterpretationReturned shape
identityKeyIdentity KeyRequired. Text; maximum UTF-16 length 8192.
hasVersionHas VersionRequired. Boolean.
hasDisplayHas DisplayRequired. Boolean.
json
{
  "input": {
    "system": "urn:example:codes",
    "code": "001",
    "version": "v2",
    "display": "Example"
  },
  "output": {
    "identityKey": "[\"urn:example:codes\",\"v2\",\"001\"]",
    "hasVersion": true,
    "hasDisplay": true
  }
}

Limitations and assumptions

  • Display does not enter the key; lexical identity does not verify terminology membership, semantic equivalence, or an authoritative version.
  • Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.

Alternative or Complementary methods

Use a complete standard-aware resolver and verify terminology, resource identity, and applicable profiles separately.

References

  1. Calculation and input contract: health-informatics/fhir-coding-version-display-pair — tool.io

Similar or alternative tools