Description
Format a one-based HL7 segment, field and component locator.
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.
Format a one-based HL7 segment, field and component locator.
When to use this tool
Use HL7 Field Component Token when checking the stated restricted health-data record, token or transition convention.
How to use the tool and how it works
- Enter segmentCode, fieldNumber, componentNumber. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read token. Use the output convention below.
Require a three-character segment token beginning with uppercase ASCII A-Z followed by uppercase letters/digits, plus positive safe whole field/component numbers. Format SEG-field.component.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| segmentCode | Segment Code | Required. Text; maximum UTF-16 length 8192. |
| fieldNumber | One-based positive safe whole field index. | Required. Safe integer; minimum 1. |
| componentNumber | One-based positive safe whole component index. | Required. Safe integer; minimum 1. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| token | JSON-encoded ordered tuple or literal token under the convention above; not a database lookup or authentication result. | Required. Text; maximum UTF-16 length 8192. |
{
"input": {
"segmentCode": "PID",
"fieldNumber": 3,
"componentNumber": 1
},
"output": {
"token": "PID-3.1"
}
}Limitations and assumptions
- Indices are one-based; segment existence, field limits and actual HL7 message structure are not checked.
- 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.
- Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Numeric signed-zero results are exported as zero.
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
Similar or alternative tools
- Healthcare Identifier Leading Zero Preservation
Preserve a decimal healthcare identifier as text and count its initial zeros.
- FHIR Resource ID Reference Split
Split a restricted relative FHIR resource reference and optional history version.