HL7.FHIR.US.ECR\eICR Trigger Code Flag Extension

This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Extension: 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.

The official URL for this extension is:

http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension

Status: active
Extension maintained by: HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)

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:

Use this Extension: Electronic Initial Case Report Composition, US Public Health Encounter

Formal Views of Extension Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from Extension

Summary

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

This structure is derived from Extension

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	eICR Trigger Code Flag
extension	0..*	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 Example General: urn:oid:2.16.840.1.114222.4.11.7508
extension:extensionTriggerCodeValueSetVersion	1..1	Extension	RCTC value set version
url	1..1	uri	"triggerCodeValueSetVersion"
value[x]	1..1	string	Value of extension Example General: 19/05/2019
extension:extensionTriggerCode	1..1	Extension	Trigger code
url	1..1	uri	"triggerCode"
value[x]	1..1	Coding	Value of extension Example General: {"system":"http://snomed.info/sct","code":"3928002","display":"Zika virus disease (disorder)"}
url	1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension"
value[x]	0..0
Documentation for this format

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	eICR Trigger Code Flag
id	0..1	string	Unique id for inter-element referencing
extension	0..*	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
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	identifies the meaning of the extension
value[x]	0..1		Value of extension
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
url	1..1	uri	"triggerCodeValueSet"
value[x]	0..1	oid	Value of extension Example General: urn:oid:2.16.840.1.114222.4.11.7508
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
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	identifies the meaning of the extension
value[x]	0..1		Value of extension
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
url	1..1	uri	"triggerCodeValueSetVersion"
value[x]	1..1	string	Value of extension Example General: 19/05/2019
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
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	identifies the meaning of the extension
value[x]	0..1		Value of extension
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
url	1..1	uri	"triggerCode"
value[x]	1..1	Coding	Value of extension Example General: {"system":"http://snomed.info/sct","code":"3928002","display":"Zika virus disease (disorder)"}
url	1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension"
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

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	eICR Trigger Code Flag
extension	0..*	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 Example General: urn:oid:2.16.840.1.114222.4.11.7508
extension:extensionTriggerCodeValueSetVersion	1..1	Extension	RCTC value set version
url	1..1	uri	"triggerCodeValueSetVersion"
value[x]	1..1	string	Value of extension Example General: 19/05/2019
extension:extensionTriggerCode	1..1	Extension	Trigger code
url	1..1	uri	"triggerCode"
value[x]	1..1	Coding	Value of extension Example General: {"system":"http://snomed.info/sct","code":"3928002","display":"Zika virus disease (disorder)"}
url	1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension"
value[x]	0..0
Documentation for this format

Snapshot View

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	eICR Trigger Code Flag
id	0..1	string	Unique id for inter-element referencing
extension	0..*	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
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	identifies the meaning of the extension
value[x]	0..1		Value of extension
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
url	1..1	uri	"triggerCodeValueSet"
value[x]	0..1	oid	Value of extension Example General: urn:oid:2.16.840.1.114222.4.11.7508
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
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	identifies the meaning of the extension
value[x]	0..1		Value of extension
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
url	1..1	uri	"triggerCodeValueSetVersion"
value[x]	1..1	string	Value of extension Example General: 19/05/2019
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
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	identifies the meaning of the extension
value[x]	0..1		Value of extension
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
url	1..1	uri	"triggerCode"
value[x]	1..1	Coding	Value of extension Example General: {"system":"http://snomed.info/sct","code":"3928002","display":"Zika virus disease (disorder)"}
url	1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension"
Documentation for this format

Other representations of extension: Schematron

Constraints

Id	Path	Details	Requirements
ele-1	Extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCodeValueSet	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:extensionTriggerCodeValueSet	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCodeValueSet.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:extensionTriggerCodeValueSet.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCodeValueSet.extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:extensionTriggerCodeValueSet.extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCodeValueSet.extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:extensionTriggerCodeValueSet.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:extensionTriggerCodeValueSetVersion	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:extensionTriggerCodeValueSetVersion	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCodeValueSetVersion.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:extensionTriggerCodeValueSetVersion.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCodeValueSetVersion.extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:extensionTriggerCodeValueSetVersion.extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCodeValueSetVersion.extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:extensionTriggerCodeValueSetVersion.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:extensionTriggerCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:extensionTriggerCode	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCode.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:extensionTriggerCode.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCode.extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:extensionTriggerCode.extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:extensionTriggerCode.extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:extensionTriggerCode.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())