FHIR Extensions Pack
5.1.0 - 5.1.0 (April 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0: Release 5.1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: ID Check digit

Official URL: http://hl7.org/fhir/StructureDefinition/identifier-checkDigit Version: 5.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: IDCheckDigit
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1626

allow for a check digit and a check digit scheme to be conveyed as part of Identifier. The rules of the ID Type determine if the check digit is part of the ID value or sent separately.

Context of Use

This extension may be used on the following element(s):

  • Element ID Identifier

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension of type string: allow for a check digit and a check digit scheme to be conveyed as part of Identifier. The rules of the ID Type determine if the check digit is part of the ID value or sent separately.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Allows for a check digit and a check digit scheme to be conveyed as part of Identifier
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/identifier-checkDigit"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Allows for a check digit and a check digit scheme to be conveyed as part of Identifier
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/identifier-checkDigit"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type string: allow for a check digit and a check digit scheme to be conveyed as part of Identifier. The rules of the ID Type determine if the check digit is part of the ID value or sent separately.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Allows for a check digit and a check digit scheme to be conveyed as part of Identifier
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/identifier-checkDigit"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Allows for a check digit and a check digit scheme to be conveyed as part of Identifier
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/identifier-checkDigit"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)