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
| Active as of 2024-02-25 |
Definitions for the Esmd-Ext-StatusCode extension.
Guidance on how to interpret the contents of this table can be found here
| 0. Extension | |
| Definition | The Esmd-Ext-StatusCode is a custom esMD FHIR resource that is used to provide detailed information about a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System to indicate that success or error conditions exist. The StatusCode provides a consistent way to track processing across systems and ensures that the status of clinical documents are accurately tracked and reported. The Esmd-Ext-StatusCode resource is used in the following esMD FHIR profile: • Esmd-FindListTransactionNotification - When used in this profile, StatusCode is used to report the status of a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System. Optional Extension Element - found in all resources. |
| Short | esMD supported Status CodeOptional Extensions Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-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. |
| Short | ExtensionAdditional 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-StatusCode |
| 6. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 10..1 |
| Binding | The codes SHALL be taken from For codes, see ESMD StatusCodes ValueSet (required to https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-StatusCodes)Codes used for esMD Custom Status Codes |
| Type | code, 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, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
| 0. Extension | |
| Definition | The Esmd-Ext-StatusCode is a custom esMD FHIR resource that is used to provide detailed information about a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System to indicate that success or error conditions exist. The StatusCode provides a consistent way to track processing across systems and ensures that the status of clinical documents are accurately tracked and reported. The Esmd-Ext-StatusCode resource is used in the following esMD FHIR profile: • Esmd-FindListTransactionNotification - When used in this profile, StatusCode is used to report the status of a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System. |
| Short | esMD supported Status Code |
| 2. Extension.extension | |
| Control | 0..0 |
| 4. Extension.url | |
| Fixed Value | https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-StatusCode |
| 6. Extension.value[x] | |
| Control | 1..? |
| Binding | The codes SHALL be taken from ESMD StatusCodes ValueSet (required to https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-StatusCodes)Codes used for esMD Custom Status Codes |
| Type | code, 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, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
| 0. Extension | |
| Definition | The Esmd-Ext-StatusCode is a custom esMD FHIR resource that is used to provide detailed information about a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System to indicate that success or error conditions exist. The StatusCode provides a consistent way to track processing across systems and ensures that the status of clinical documents are accurately tracked and reported. The Esmd-Ext-StatusCode resource is used in the following esMD FHIR profile: • Esmd-FindListTransactionNotification - When used in this profile, StatusCode is used to report the status of a clinical document at the transaction level as it passes through various stages of validation, processing, and routing within the esMD System. |
| Short | esMD supported Status Code |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-StatusCode |
| 8. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ESMD StatusCodes ValueSet (required to https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-StatusCodes)Codes used for esMD Custom Status Codes |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |