HL7.FHIR.US.ECR\RR eICR Processing Status Reason Observation

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

Resource Profile: RR eICR Processing Status Reason Observation

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-reason-observation				Version: 2.1.0
Active as of 2022-08-31				Computable Name: RR_Eicr_Processing_Status_Reason_Observation

This Observation profile represents, if the incoming eICR was not successfully processed for a determination of reportability, the reason it was not processed.

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 component observations 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:

Refer to this Resource Profile:
Examples for this Resource Profile: Observation/observation-rr-eicr-processing-status-reason

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Observation

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 3 elements
Fixed Value: 1 element

This structure is derived from Observation

Name	Flags	Card.	Type	Description & Constraints
Observation	S	0..*	Observation	eICR Processing Status Reason
status		1..1	code	registered \| preliminary \| final \| amended + Fixed Value: final
code		1..1	CodeableConcept	Type of observation (code / type) Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.114222.4.5.232
code		1..1	code	Symbol in syntax defined by the system Fixed Value: RR6
display		1..1	string	Representation defined by the system Fixed Value: eICR Processing Status Reason
value[x]		0..1	CodeableConcept	Processing status reason Binding: eICR Processing Status Reason (eCR) (extensible): Processing Status Reason Example Example for CodeableConcept: {"coding":[{"system":"urn:oid:2.16.840.1.114222.4.5.274","code":"RRVS30","display":"eICR was processed with the warning of: inactive RCTC code"}]}
component	S	0..*	BackboneElement	eICR Processing Status Reason Detail
code	S	1..1	CodeableConcept	Type of processing status reason detail Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type Example General: {"coding":[{"system":"urn:oid:2.16.840.1.114222.4.5.274","code":"RRVS32","display":"Inactive RCTC code detail"}]}
value[x]	S	1..1		Processing status reason detail Example General: {"coding":[{"system":"http://snomed.info/sct","code":"69092001","display":"Leptospirosis icterohemorrhagica (disorder)"}]}
valueCodeableConcept			CodeableConcept
valueString			string
Documentation for this format

Description & Constraints

Observation

SI

0..*

Observation

eICR Processing Status Reason

id

Σ

0..1

string

Logical id of this artifact

category

0..*

CodeableConcept

Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

code

Σ

1..1

CodeableConcept

Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

Required Pattern: At least the following

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

coding

1..*

Coding

Code defined by a terminology system
Fixed Value: (complex)

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

system

1..1

uri

Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.114222.4.5.232

version

0..1

string

Version of the system - if relevant

code

1..1

code

Symbol in syntax defined by the system
Fixed Value: RR6

display

1..1

string

Representation defined by the system
Fixed Value: eICR Processing Status Reason

userSelected

0..1

boolean

If this coding was chosen directly by the user

text

0..1

string

Plain text representation of the concept

subject

Σ

0..1

Reference(Patient | Group | Device | Location)

Who and/or what the observation is about

focus

Σ

0..*

Reference(Resource)

What the observation is about, when it is not about the subject of record

encounter

Σ

0..1

Reference(Encounter)

Healthcare event during which this observation is made

effective[x]

Σ

0..1

Clinically relevant time/time-period for observation

effectiveDateTime

effectivePeriod

effectiveTiming

effectiveInstant

issued

Σ

0..1

instant

Date/Time this version was made available

performer

Σ

0..*

Who is responsible for the observation

value[x]

ΣI

0..1

CodeableConcept

Processing status reason
Binding: eICR Processing Status Reason (eCR) (extensible): Processing Status Reason

Example Example for CodeableConcept: {"coding":[{"system":"urn:oid:2.16.840.1.114222.4.5.274","code":"RRVS30","display":"eICR was processed with the warning of: inactive RCTC code"}]}

dataAbsentReason

I

0..1

CodeableConcept

Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

interpretation

0..*

CodeableConcept

High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.

note

0..*

Annotation

Comments about the observation

bodySite

0..1

CodeableConcept

Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

method

0..1

CodeableConcept

How it was done
Binding: ObservationMethods (example): Methods for simple observations.

specimen

0..1

Reference(Specimen)

Specimen used for this observation

device

0..1

Reference(Device | DeviceMetric)

(Measurement) Device

referenceRange

I

0..*

BackboneElement

Provides guide for interpretation

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

low

I

0..1

SimpleQuantity

Low Range, if relevant

high

I

0..1

SimpleQuantity

High Range, if relevant

type

0..1

CodeableConcept

Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

appliesTo

0..*

CodeableConcept

Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.

age

0..1

Range

Applicable age range, if relevant

text

0..1

string

Text based reference range in an observation

hasMember

Σ

0..*

Reference(Observation | QuestionnaireResponse | MolecularSequence)

Related resource that belongs to the Observation group

derivedFrom

Σ

0..*

Related measurements the observation is made from

component

SΣ

0..*

BackboneElement

eICR Processing Status Reason Detail

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

code

SΣ

1..1

CodeableConcept

Type of processing status reason detail
Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type

Example General: {"coding":[{"system":"urn:oid:2.16.840.1.114222.4.5.274","code":"RRVS32","display":"Inactive RCTC code detail"}]}

value[x]

SΣ

1..1

Processing status reason detail
Example General: {"coding":[{"system":"http://snomed.info/sct","code":"69092001","display":"Leptospirosis icterohemorrhagica (disorder)"}]}

valueCodeableConcept

CodeableConcept

valueString

string

dataAbsentReason

I

0..1

CodeableConcept

Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

interpretation

0..*

CodeableConcept

High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.

referenceRange

0..*

See referenceRange (Observation)

Provides guide for interpretation of component result

Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Observation	I	0..*	Observation	eICR Processing Status Reason
component	Σ	0..*	BackboneElement	eICR Processing Status Reason Detail
code	Σ	1..1	CodeableConcept	Type of processing status reason detail Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type
value[x]	Σ	1..1		Processing status reason detail
valueCodeableConcept			CodeableConcept
valueString			string
Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 3 elements
Fixed Value: 1 element

Differential View

This structure is derived from Observation

Name	Flags	Card.	Type	Description & Constraints
Observation	S	0..*	Observation	eICR Processing Status Reason
status		1..1	code	registered \| preliminary \| final \| amended + Fixed Value: final
code		1..1	CodeableConcept	Type of observation (code / type) Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.114222.4.5.232
code		1..1	code	Symbol in syntax defined by the system Fixed Value: RR6
display		1..1	string	Representation defined by the system Fixed Value: eICR Processing Status Reason
value[x]		0..1	CodeableConcept	Processing status reason Binding: eICR Processing Status Reason (eCR) (extensible): Processing Status Reason Example Example for CodeableConcept: {"coding":[{"system":"urn:oid:2.16.840.1.114222.4.5.274","code":"RRVS30","display":"eICR was processed with the warning of: inactive RCTC code"}]}
component	S	0..*	BackboneElement	eICR Processing Status Reason Detail
code	S	1..1	CodeableConcept	Type of processing status reason detail Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type Example General: {"coding":[{"system":"urn:oid:2.16.840.1.114222.4.5.274","code":"RRVS32","display":"Inactive RCTC code detail"}]}
value[x]	S	1..1		Processing status reason detail Example General: {"coding":[{"system":"http://snomed.info/sct","code":"69092001","display":"Leptospirosis icterohemorrhagica (disorder)"}]}
valueCodeableConcept			CodeableConcept
valueString			string
Documentation for this format

Snapshot View

Description & Constraints

Observation

SI

0..*

Observation

eICR Processing Status Reason

id

Σ

0..1

string

Logical id of this artifact

Terminology Bindings

Path	Conformance	ValueSet / Code
Observation.language	preferred	CommonLanguages Max Binding: AllLanguages
Observation.status	required	Fixed Value: final
Observation.category	preferred	ObservationCategoryCodes
Observation.code	example	Pattern: RR6("eICR Processing Status Reason")
Observation.value[x]	extensible	RRVS_eICRProcessingStatusReason_eCR
Observation.dataAbsentReason	extensible	DataAbsentReason
Observation.interpretation	extensible	ObservationInterpretationCodes
Observation.bodySite	example	SNOMEDCTBodyStructures
Observation.method	example	ObservationMethods
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes
Observation.component.code	extensible	RRVS_ProcessingStatusReasonDetailType_eCR
Observation.component.dataAbsentReason	extensible	DataAbsentReason
Observation.component.interpretation	extensible	ObservationInterpretationCodes

Constraints

Id	Grade	Path	Details	Requirements
dom-2	error	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Observation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Observation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Best Practice	Observation	A resource should have narrative for robust management : text.`div`.exists()
obs-6	error	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
ele-1	error	Observation.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.focus	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.encounter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.effective[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.issued	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.dataAbsentReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.interpretation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.bodySite	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.method	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.specimen	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.device	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
obs-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.exists()
ele-1	error	Observation.referenceRange.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.referenceRange.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.referenceRange.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.referenceRange.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.referenceRange.low	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.high	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.appliesTo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.age	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.referenceRange.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.hasMember	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.derivedFrom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.component.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.component.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Observation.component.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Observation.component.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.dataAbsentReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.interpretation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Observation.component.referenceRange	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2020+ HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). Package hl7.fhir.us.ecr#2.1.0 based on FHIR 4.0.1. Generated 2022-08-31
Links: Table of Contents | QA Report | Version History | | Propose a change