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
Data Type Profile: Letter Identifier
| Official URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Idn-TransactionId | Version: 1.0.0 | |||
| Draft as of 2024-02-25 | Computable Name: EsmdIdnTransactionId | |||
The Esmd-Idn-TransactionId is a custom esMD FHIR resource that is used to transmit a unique identifier which is assigned by the esMD System to track transactions received from Health Information Handlers (HIHs) or Providers. When a transaction is received, esMD generates and assigns the TransactionId. It then uses it to provide clear and efficient tracking for auditing, status reporting, and seamless management of submissions and responses within the esMD workflow. The Esmd-Idn-TransactionId resource is used in the following esMD FHIR profiles: • Esmd-DocumentReference - When used in this profile, the TransactionId represents a unique identifier which is used by the esMD System to track a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System. • Esmd-ListDeliveryConfirmation - When used in this profile, the TransactionId is used as a unique identifier that enables users to confirm the delivery of a specific clinical document using esMD's notification features.
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.
| 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-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics |
  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-TransactionId |
 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 esMD Transation ID: SRC361990001571 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from 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-transactionid-1 | error | Identifier | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') |
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier | An identifier intended for computation esmd-idn-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics |
| 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-TransactionId | |
| value |
C | 1..1 | string | The value that is unique Example esMD Transation ID: SRC361990001571 |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| esmd-idn-transactionid-1 | error | Identifier | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier | An identifier intended for computation esmd-idn-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics |
| 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-TransactionId |
| value |
ΣC | 1..1 | string | The value that is unique Example General: 123456 Example esMD Transation ID: SRC361990001571 |
| 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: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom 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-transactionid-1 | error | Identifier | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Identifier
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-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics |
| 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-TransactionId |
| 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 esMD Transation ID: SRC361990001571 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from 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-transactionid-1 | error | Identifier | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') |
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-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics |
| 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-TransactionId | |
| value |
C | 1..1 | string | The value that is unique Example esMD Transation ID: SRC361990001571 |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| esmd-idn-transactionid-1 | error | Identifier | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier | An identifier intended for computation esmd-idn-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics |
| 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-TransactionId |
| value |
ΣC | 1..1 | string | The value that is unique Example General: 123456 Example esMD Transation ID: SRC361990001571 |
| 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: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom 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-transactionid-1 | error | Identifier | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron