Description
Split a restricted relative FHIR resource reference and optional history version.
Health-information systems separate identifiers, code-system namespaces, source versions, missing-value states and reference syntax. Recording a mapping or recognizing a restricted token does not validate its clinical meaning or a complete HL7/FHIR resource. Explicit null, empty text, unknown status and numeric zero are different states.
Split a restricted relative FHIR resource reference and optional history version.
When to use this tool
Use FHIR Resource ID Reference Split when checking the stated restricted health-data record, token or transition convention.
How to use the tool and how it works
- Enter reference. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read resourceType, resourceId, versionId, versioned. Inspect versioned before interpreting the associated values.
Parse a restricted relative reference ResourceType/id, optionally followed by /_history/version. Resource type starts uppercase then uses ASCII letters/digits; ID/version allow 1..64 letters, digits, dots or hyphens. Return components, empty version when absent, and versioned flag.1
FHIR permits multiple reference forms, including version-specific relative references. The restricted relative-reference grammar here does not cover all permitted reference representations.2
| Input field | Meaning and units | Accepted input |
|---|---|---|
| reference | Supplied comparison value with compatible units and reporting basis. | Required. Text; maximum UTF-16 length 8192. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| resourceType | ASCII uppercase-first alphanumeric token; not checked against actual FHIR resource types. | Required. Text; maximum UTF-16 length 8192. |
| resourceId | Restricted 1..64 ASCII letters/digits/dots/hyphens, preserved without decoding. | Required. Text; maximum UTF-16 length 8192. |
| versionId | Empty string when absent; inspect versioned before interpreting. | Required. Text; maximum UTF-16 length 8192. |
| versioned | Versioned | Required. Boolean. |
{
"input": {
"reference": "Patient/p17/_history/2"
},
"output": {
"resourceType": "Patient",
"resourceId": "p17",
"versionId": "2",
"versioned": true
}
}Limitations and assumptions
- Absolute URLs, contained-resource fragments and URNs are outside this grammar; resource types are not checked against FHIR's actual type registry.
- 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 the intended complete interoperability specification, authoritative terminology and verified source records for actual resource validation, semantic mapping or clinical use.
References
-
Calculation and input contract: health-informatics/fhir-resource-id-reference-split — tool.io
-
FHIR R5: Resource References — HL7 International
Similar or alternative tools
- FHIR Quantity Comparator Token
Check and preserve one of the five FHIR R5 quantity-comparator tokens.
- Healthcare Identifier Leading Zero Preservation
Preserve a decimal healthcare identifier as text and count its initial zeros.