ESMD FHIR Implementation Guide
1.0.0 - esmd

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

Extension: EsmdExtTransactionId - Detailed Descriptions

Active as of 2024-02-25

Definitions for the Esmd-Ext-TransactionId extension.

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition

The Esmd-Ext-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-Ext-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.


Optional Extension Element - found in all resources.

ShortESMD Transaction IDOptional Extensions Element
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
    • 4. Extension.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttps://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId
    6. Extension.value[x]
    Definition

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortValue of extension
    Control10..1
    This element is affected by the following invariants: esmd-transactionid-1
    Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    esmd-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics (value.matches('^[A-Za-z0-9]{15}$'))

    Guidance on how to interpret the contents of this table can be found here

    0. Extension
    Definition

    The Esmd-Ext-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-Ext-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.

    ShortESMD Transaction ID
    2. Extension.extension
    Control0..0
    4. Extension.url
    Fixed Valuehttps://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId
    6. Extension.value[x]
    Control1..?
    This element is affected by the following invariants: esmd-transactionid-1
    Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Invariantsesmd-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics (value.matches('^[A-Za-z0-9]{15}$'))

    Guidance on how to interpret the contents of this table can be found here

    0. Extension
    Definition

    The Esmd-Ext-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-Ext-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.

    ShortESMD Transaction ID
    Control0..*
    This element is affected by the following invariants: ele-1
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    2. Extension.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    4. Extension.extension
    Definition

    An Extension

    ShortExtension
    Control0..0
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
      • 6. Extension.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId
      8. Extension.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control1..1
      This element is affected by the following invariants: esmd-transactionid-1
      Typestring
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      esmd-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics (value.matches('^[A-Za-z0-9]{15}$'))