HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2 United States of America flag

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Extension: RR eICR Processing Status Extension

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension Version: 2.1.2
Active as of 2024-10-30 Computable Name: RR_Eicr_Processing_Status_Extension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.17

This Extension profile represents the eICR processing status.

Context of Use

This extension may be used on the following element(s):

  • Element ID Composition.section

If the eICR was not processed or was processed with a warning, the reason will be contained in the eICR Processing Status Reason. If there is any output from a validator, that output will be contained in the eICR Validation Output.

If any of the trigger codes used to generate the eICR are from an outdated version of the RCTC or the codes are deprecated by the coding system in the latest version of the RCTC (inactive status), these are flagged and and the eICR Processing Status Reason Detail will hold the details of the outdated and expected versions of the RCTC. Inactive status in the RCTC signifies that a code as been deprecated by the source coding system. Codes with an inactive status will remain in the RCTC and be available for triggering because EHR systems do not update to the most recent version of the coding systems immediately, and thus may continue to trigger on a deprecated code.

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: This Extension profile represents the eICR processing status.

  • eICRProcessingStatus: Reference: An Extension
  • eICRValidationOutput: markdown, string, Attachment: Contains eICR validation output - this could be the actual output from a validator, or a link to a validation output file

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension eICR Processing Status
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:eICRProcessingStatus 1..1 Extension Extension
..... url 1..1 uri "eICRProcessingStatus"
..... value[x] 1..1 Reference(eICR Processing Status Observation) Value of extension
.... extension:eICRValidationOutput 0..* Extension Extension
..... url 1..1 uri "eICRValidationOutput"
..... value[x] 1..1 Value of extension
...... valueMarkdown markdown
...... valueString string
...... valueAttachment Attachment
... url 1..1 uri "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension eICR Processing Status
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:eICRProcessingStatus 1..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "eICRProcessingStatus"
..... value[x] 1..1 Reference(eICR Processing Status Observation) Value of extension
.... extension:eICRValidationOutput 0..* Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "eICRValidationOutput"
..... value[x] 1..1 Value of extension
...... valueMarkdown markdown
...... valueString string
...... valueAttachment Attachment
... url 1..1 uri "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This Extension profile represents the eICR processing status.

  • eICRProcessingStatus: Reference: An Extension
  • eICRValidationOutput: markdown, string, Attachment: Contains eICR validation output - this could be the actual output from a validator, or a link to a validation output file

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension eICR Processing Status
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:eICRProcessingStatus 1..1 Extension Extension
..... url 1..1 uri "eICRProcessingStatus"
..... value[x] 1..1 Reference(eICR Processing Status Observation) Value of extension
.... extension:eICRValidationOutput 0..* Extension Extension
..... url 1..1 uri "eICRValidationOutput"
..... value[x] 1..1 Value of extension
...... valueMarkdown markdown
...... valueString string
...... valueAttachment Attachment
... url 1..1 uri "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension eICR Processing Status
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:eICRProcessingStatus 1..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "eICRProcessingStatus"
..... value[x] 1..1 Reference(eICR Processing Status Observation) Value of extension
.... extension:eICRValidationOutput 0..* Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "eICRValidationOutput"
..... value[x] 1..1 Value of extension
...... valueMarkdown markdown
...... valueString string
...... valueAttachment Attachment
... url 1..1 uri "http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-extension"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()