HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR)

This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 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

SD.13 StructureDefinition-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. 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

SD.13.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension

Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.

This profile builds on Extension

Differential Table
Snapshot Table
All

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	eICR Trigger Code Flag
extension	0..*	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	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	Example General: 19/05/2019
extension:extensionTriggerCode	1..1	Extension	Trigger code
url	1..1	uri	"triggerCode"
value[x]	1..1	Coding	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	Flags	Card.	Type	Description & Constraints
Extension	I	0..*	Extension	eICR Trigger Code Flag
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extensionTriggerCodeValueSet	I	1..1	Extension	RCTC value set OID
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	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]	I	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]	I	0..1	oid	Value of extension Example General: urn:oid:2.16.840.1.114222.4.11.7508
extension:extensionTriggerCodeValueSetVersion	I	1..1	Extension	RCTC value set version
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	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]	I	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]	I	1..1	string	Value of extension Example General: 19/05/2019
extension:extensionTriggerCode	I	1..1	Extension	Trigger code
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	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]	I	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]	I	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

Differential View

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	eICR Trigger Code Flag
extension	0..*	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	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	Example General: 19/05/2019
extension:extensionTriggerCode	1..1	Extension	Trigger code
url	1..1	uri	"triggerCode"
value[x]	1..1	Coding	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	Flags	Card.	Type	Description & Constraints
Extension	I	0..*	Extension	eICR Trigger Code Flag
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extensionTriggerCodeValueSet	I	1..1	Extension	RCTC value set OID
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	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]	I	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]	I	0..1	oid	Value of extension Example General: urn:oid:2.16.840.1.114222.4.11.7508
extension:extensionTriggerCodeValueSetVersion	I	1..1	Extension	RCTC value set version
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	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]	I	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]	I	1..1	string	Value of extension Example General: 19/05/2019
extension:extensionTriggerCode	I	1..1	Extension	Trigger code
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	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]	I	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]	I	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

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

See the Conformance requirements for a complete list of supported RESTful interactions for this IG.