HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.0 - STU 2 US

This page is part of the electronic Case Reporting (eCR) (v2.1.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). 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.0
Active as of 2022-08-31 Computable Name: Eicr_Trigger_Code_Flag_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.

Context of Use

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

  • Composition.section.entry
  • 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

Mandatory: 5 elements
Fixed Value: 4 elements
Prohibited: 1 element

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensioneICR Trigger Code Flag
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:extensionTriggerCodeValueSet 1..1ExtensionRCTC value set OID
.... url 1..1uri"triggerCodeValueSet"
.... value[x] 0..1oidValue of extension
Example General: urn:oid:2.16.840.1.114222.4.11.7508
... extension:extensionTriggerCodeValueSetVersion 1..1ExtensionRCTC value set version
.... url 1..1uri"triggerCodeValueSetVersion"
.... value[x] 1..1stringValue of extension
Example General: 2020-11-13
.... url 1..1uri"triggerCode"
.... value[x] 1..1CodingValue of extension
Example General: {"system":"http://snomed.info/sct","code":"3928002","display":"Zika virus disease (disorder)"}
... url 1..1uri"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..*ExtensioneICR Trigger Code Flag
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:extensionTriggerCodeValueSet 1..1ExtensionRCTC value set OID
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"triggerCodeValueSet"
.... value[x] 0..1oidValue of extension
Example General: urn:oid:2.16.840.1.114222.4.11.7508
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"triggerCodeValueSetVersion"
.... value[x] 1..1stringValue of extension
Example General: 2020-11-13
... extension:extensionTriggerCode 1..1ExtensionTrigger code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"triggerCode"
.... value[x] 1..1CodingValue of extension
Example General: {"system":"http://snomed.info/sct","code":"3928002","display":"Zika virus disease (disorder)"}
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 5 elements
Fixed Value: 4 elements
Prohibited: 1 element

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensioneICR Trigger Code Flag
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:extensionTriggerCodeValueSet 1..1ExtensionRCTC value set OID
.... url 1..1uri"triggerCodeValueSet"
.... value[x] 0..1oidValue of extension
Example General: urn:oid:2.16.840.1.114222.4.11.7508
... extension:extensionTriggerCodeValueSetVersion 1..1ExtensionRCTC value set version
.... url 1..1uri"triggerCodeValueSetVersion"
.... value[x] 1..1stringValue of extension
Example General: 2020-11-13
.... url 1..1uri"triggerCode"
.... value[x] 1..1CodingValue of extension
Example General: {"system":"http://snomed.info/sct","code":"3928002","display":"Zika virus disease (disorder)"}
... url 1..1uri"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..*ExtensioneICR Trigger Code Flag
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:extensionTriggerCodeValueSet 1..1ExtensionRCTC value set OID
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"triggerCodeValueSet"
.... value[x] 0..1oidValue of extension
Example General: urn:oid:2.16.840.1.114222.4.11.7508
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"triggerCodeValueSetVersion"
.... value[x] 1..1stringValue of extension
Example General: 2020-11-13
... extension:extensionTriggerCode 1..1ExtensionTrigger code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"triggerCode"
.... value[x] 1..1CodingValue of extension
Example General: {"system":"http://snomed.info/sct","code":"3928002","display":"Zika virus disease (disorder)"}
... url 1..1uri"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

IdGradePathDetailsRequirements
ele-1errorExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:extensionTriggerCodeValueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:extensionTriggerCodeValueSetMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:extensionTriggerCodeValueSet.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:extensionTriggerCodeValueSet.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:extensionTriggerCodeValueSet.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:extensionTriggerCodeValueSetVersionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:extensionTriggerCodeValueSetVersionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:extensionTriggerCodeValueSetVersion.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:extensionTriggerCodeValueSetVersion.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:extensionTriggerCodeValueSetVersion.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:extensionTriggerCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:extensionTriggerCodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:extensionTriggerCode.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:extensionTriggerCode.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:extensionTriggerCode.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())