Extension: NamingSystem Check Digit

Modeling and Methodology Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit`				Version: 5.0.0-snapshot3
draft as of 2022-09-04				Computable Name: NSCheckDigit
Flags: Non-Modifier				OID: TBD

Context of Use: Use on Element ID NamingSystem

Definition

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

Summary

Name	Flags	Card.	Type	Description & Constraints
NSCheckDigit		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit NSCheckDigit: allow for a check digit and a check digit scheme to be conveyed as part of Naming System. The rules of the ID Type determine if the check digit is part of the ID value or sent separately. Use on Element ID NamingSystem
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit NSCheckDigit: allow for a check digit and a check digit scheme to be conveyed as part of Naming System. The rules of the ID Type determine if the check digit is part of the ID value or sent separately. Use on Element ID NamingSystem
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- NSCheckDigit -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // NSCheckDigit
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit", // R! 
    "valueString" : "<string>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
NSCheckDigit		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit NSCheckDigit: allow for a check digit and a check digit scheme to be conveyed as part of Naming System. The rules of the ID Type determine if the check digit is part of the ID value or sent separately. Use on Element ID NamingSystem
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit NSCheckDigit: allow for a check digit and a check digit scheme to be conveyed as part of Naming System. The rules of the ID Type determine if the check digit is part of the ID value or sent separately. Use on Element ID NamingSystem
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- NSCheckDigit -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // NSCheckDigit
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/namingsystem-checkDigit", // R! 
    "valueString" : "<string>" // I R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.