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

This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: eICR Trigger Code Flag Extension

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension Version: 2.1.2
Active as of 2024-10-30 Computable Name: Eicr_Trigger_Code_Flag_Extension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.10

This Extension profile represents a flag which, if it is present, indicates that the target reference represents a triggering event and caused the eCR to be generated.

Context of Use

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

  • Element ID Composition.section.entry
  • Element ID Encounter.diagnosis

It contains the trigger code which is the same as the trigger code in the resource and is used to identify which code(s) in a resource that allows multiple trigger codes (e.g. US Core Observation Lab where a trigger code could be contained in either the code (lab test) or the value (lab test result) or in the case of a battery or panel of tests, in the hasMember as another US Core Observation Lab code or value). It also contains the RCTC OID and RCTC version of the value set from which the code was matched.

It is available for use in the following places:

  • eICR Encounter
    • flags a code contained in Condition.code (eICR Condition) which is contained in Encounter.diagnosis (eICR Encounter) - diagnosis
  • Problem Section entry
    • flags a code contained in Condition.code (eICR Condition) - diagnosis
  • Plan of Treatment Section entry
    • flags a code contained in ServiceRequest.code (eICR ServiceRequest) - test being requested
  • Results Section entry
    • flags codes contained in:
      • Observation.code (US Core Laboratory Result Observation Profile code) - test performed/battery or panel name
      • Observation.value (US Core Laboratory Result Observation Profile value) - test result
      • Observation.code referenced in containing Observation.hasMember (US Core Laboratory Result Observation Profile code) - member of panel test performed
      • Observation.value referenced in containing Observation.hasMember (US Core Laboratory Result Observation Profile value) - member of panel test result
  • Medications Section entry
    • flags a code contained in MedicationAdministration.medicationCodeableConcept - medication
  • Immunization Section entry
    • flags a code contained in US Core Immunization (Immunization.vaccineCode) - vaccine
  • Procedures Section entry
    • flags a code contained in US Core Procedure (Procedure.code) - procedure

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 a flag which, if it is present, indicates that the target reference represents a triggering event and caused the eCR to be generated.

  • extensionTriggerCodeValueSet: oid: RCTC value set OID
  • extensionTriggerCodeValueSetVersion: string: RCTC value set version
  • extensionTriggerCode: Coding: Trigger code - this code is the same as the trigger code in the resource and is used to identify which code(s) in a resource that allows multiple trigger codes (e.g. US Core Observation Lab where a trigger code could be contained in either the code (lab test) or the value (lab test result) or in the case of a battery or panel of tests, in the hasMember as another US Core Observation Lab code or value).

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension eICR Trigger Code Flag
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:extensionTriggerCodeValueSet 1..1 Extension RCTC value set OID
..... url 1..1 uri "triggerCodeValueSet"
..... value[x] 0..1 oid Value of extension
.... extension:extensionTriggerCodeValueSetVersion 1..1 Extension RCTC value set version
..... url 1..1 uri "triggerCodeValueSetVersion"
..... value[x] 1..1 string Value of extension
.... extension:extensionTriggerCode 1..1 Extension Trigger code
..... url 1..1 uri "triggerCode"
..... value[x] 1..1 Coding Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension eICR Trigger Code Flag
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:extensionTriggerCodeValueSet 1..1 Extension RCTC value set OID
..... 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 "triggerCodeValueSet"
..... value[x] 0..1 oid Value of extension
.... extension:extensionTriggerCodeValueSetVersion 1..1 Extension RCTC value set version
..... 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 "triggerCodeValueSetVersion"
..... value[x] 1..1 string Value of extension
.... extension:extensionTriggerCode 1..1 Extension Trigger code
..... 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 "triggerCode"
..... value[x] 1..1 Coding Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This Extension profile represents a flag which, if it is present, indicates that the target reference represents a triggering event and caused the eCR to be generated.

  • extensionTriggerCodeValueSet: oid: RCTC value set OID
  • extensionTriggerCodeValueSetVersion: string: RCTC value set version
  • extensionTriggerCode: Coding: Trigger code - this code is the same as the trigger code in the resource and is used to identify which code(s) in a resource that allows multiple trigger codes (e.g. US Core Observation Lab where a trigger code could be contained in either the code (lab test) or the value (lab test result) or in the case of a battery or panel of tests, in the hasMember as another US Core Observation Lab code or value).

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension eICR Trigger Code Flag
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:extensionTriggerCodeValueSet 1..1 Extension RCTC value set OID
..... url 1..1 uri "triggerCodeValueSet"
..... value[x] 0..1 oid Value of extension
.... extension:extensionTriggerCodeValueSetVersion 1..1 Extension RCTC value set version
..... url 1..1 uri "triggerCodeValueSetVersion"
..... value[x] 1..1 string Value of extension
.... extension:extensionTriggerCode 1..1 Extension Trigger code
..... url 1..1 uri "triggerCode"
..... value[x] 1..1 Coding Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension eICR Trigger Code Flag
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:extensionTriggerCodeValueSet 1..1 Extension RCTC value set OID
..... 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 "triggerCodeValueSet"
..... value[x] 0..1 oid Value of extension
.... extension:extensionTriggerCodeValueSetVersion 1..1 Extension RCTC value set version
..... 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 "triggerCodeValueSetVersion"
..... value[x] 1..1 string Value of extension
.... extension:extensionTriggerCode 1..1 Extension Trigger code
..... 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 "triggerCode"
..... value[x] 1..1 Coding Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-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()