ESMD FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• JSON

Data Type Profile: Letter Identifier

The Esmd-Idn-UniqueId is a custom esMD FHIR resource that is used by the esMD System to serve as a distinctly unique identifier for each individual submission that is received by esMD. It ensures that every submission, whether a document, claim, or other transaction, can be uniquely identified and tracked throughout the submission and review process. The UniqueID plays a crucial role in preventing duplication, ensuring proper routing, and facilitating accurate processing and auditing of clinical documents within the esMD system.

Usage:

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

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	An identifier intended for computation ele-1: All FHIR elements must have a @value or children esmd-idn-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Required Pattern: official
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://esmdfhir.cms.gov/fhir/StructureDefinition/Esmd-Idn-UniqueId
value	ΣC	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 Example Bundle Submission Unique Identifier: UniqueID361990001571
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	Pattern: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
esmd-idn-uid-1	error	Identifier	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	An identifier intended for computation esmd-idn-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
system		1..1	uri	The namespace for the identifier value Fixed Value: http://esmdfhir.cms.gov/fhir/StructureDefinition/Esmd-Idn-UniqueId
value	C	1..1	string	The value that is unique Example Bundle Submission Unique Identifier: UniqueID361990001571
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
esmd-idn-uid-1	error	Identifier	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	An identifier intended for computation esmd-idn-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://esmdfhir.cms.gov/fhir/StructureDefinition/Esmd-Idn-UniqueId
value	ΣC	1..1	string	The value that is unique Example General: 123456 Example Bundle Submission Unique Identifier: UniqueID361990001571
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	Pattern: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
esmd-idn-uid-1	error	Identifier	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	An identifier intended for computation ele-1: All FHIR elements must have a @value or children esmd-idn-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Required Pattern: official
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://esmdfhir.cms.gov/fhir/StructureDefinition/Esmd-Idn-UniqueId
value	ΣC	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 Example Bundle Submission Unique Identifier: UniqueID361990001571
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	Pattern: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
esmd-idn-uid-1	error	Identifier	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')

Differential View

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	An identifier intended for computation esmd-idn-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
system		1..1	uri	The namespace for the identifier value Fixed Value: http://esmdfhir.cms.gov/fhir/StructureDefinition/Esmd-Idn-UniqueId
value	C	1..1	string	The value that is unique Example Bundle Submission Unique Identifier: UniqueID361990001571
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
esmd-idn-uid-1	error	Identifier	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	An identifier intended for computation esmd-idn-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://esmdfhir.cms.gov/fhir/StructureDefinition/Esmd-Idn-UniqueId
value	ΣC	1..1	string	The value that is unique Example General: 123456 Example Bundle Submission Unique Identifier: UniqueID361990001571
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	Pattern: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
esmd-idn-uid-1	error	Identifier	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

Other representations of profile: CSV, Excel, Schematron