Skip to content

Main content
Bookmark this: tool.io/health-informatics/fhir-reference-version-history-token

FHIR Reference Version History Token Tool

Parse the relative resource/id/history FHIR-reference subset without resolving a server or validating resource-type membership.

Loading tool…

Description

Parse a supported relative ResourceType/id with optional /_history/version, using 1-64 ASCII identifier characters.

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.

Parse a supported relative ResourceType/id with optional /_history/version, using 1-64 ASCII identifier characters.

When to use this tool

Use FHIR Reference Version History Token when you need one supported clinical-reference or scoped-identifier component.

How to use the tool and how it works

  1. Enter reference. 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 resourceType, id, version, versioned. Inspect versioned before interpreting the associated values.

Parse a supported relative ResourceType/id with optional /_history/version, using 1-64 ASCII identifier characters. Return resourceType, id, version or empty placeholder, and versioned.1

FHIR references may identify a resource version through a history path. This parser handles its stated relative spelling subset and does not resolve or validate the target resource.2

Input fieldMeaning and unitsAccepted input
referenceSupplied reference token under the supported grammar.Required. Text; maximum UTF-16 length 8192.
Output fieldInterpretationReturned shape
resourceTypeResource TypeRequired. Text; maximum UTF-16 length 8192.
idIdRequired. Text; maximum UTF-16 length 8192.
versionVersion identifier, or empty-string placeholder when versioned is false.Required. Text; maximum UTF-16 length 8192.
versionedVersionedRequired. Boolean.
json
{
  "input": {
    "reference": "Patient/abc-1/_history/v2"
  },
  "output": {
    "resourceType": "Patient",
    "id": "abc-1",
    "version": "v2",
    "versioned": true
  }
}

Limitations and assumptions

  • This parser requires a type starting uppercase with subsequent letters; it does not recognize a resource-type registry, resolve a server, validate a resource, or accept absolute references.
  • 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-reference-version-history-token — tool.io

  2. FHIR R4: References — Health Level Seven International

Similar or alternative tools

  • FHIR Reference Relative Type ID

    Parse exactly an uppercase-leading alphanumeric resource-type token, slash, and 1-64 ASCII letters, digits, dots, or hyphens for logicalId.

  • FHIR Reference Depth Count

    Separate the first fragment, remove a scheme-and-authority prefix and query, then count nonempty slash path segments.

Support Tool.io