Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 Ballot United States of America flag

Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: eICR Processing Status Reason Observation

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-reason-observation Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: RREicrProcessingStatusReasonObservation
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.19

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation eICR Processing Status Reason
Constraints: obs-6, obs-7
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.code This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR6",
      "display" : "eICR Processing Status Reason"
    }
  ]
}
Observation.value[x] This element is included in summaries. C 0..1 CodeableConcept Processing status reason
Binding: eICR Processing Status Reason (eCR) (extensible): Processing Status Reason
Observation.component This element must be supported. This element is included in summaries. 0..* BackboneElement eICR Processing Status Reason Detail
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of processing status reason detail
Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type
Observation.component.value[x] This element must be supported. This element is included in summaries. 1..1 Processing status reason detail
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.value[x] Base extensible eICR Processing Status Reason (eCR) 📦1 us.cdc.phinvads v0.12
Observation.component.​code Base extensible eICR Processing Status Reason Detail Type (eCR) 📦1 us.cdc.phinvads v0.12

Constraints

Id Grade Path(s) Description Expression
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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.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()

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* Observation eICR Processing Status Reason
Observation.code 1..1 CodeableConcept Type of observation (code / type)
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR6",
      "display" : "eICR Processing Status Reason"
    }
  ]
}
Observation.value[x] 0..1 CodeableConcept Processing status reason
Binding: eICR Processing Status Reason (eCR) (extensible): Processing Status Reason
Observation.component This element must be supported. 0..* BackboneElement eICR Processing Status Reason Detail
Observation.component.code This element must be supported. 1..1 CodeableConcept Type of processing status reason detail
Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type
Observation.component.value[x] This element must be supported. 1..1 Processing status reason detail
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.value[x] Base extensible eICR Processing Status Reason (eCR) 📦1 us.cdc.phinvads v0.12
Observation.component.​code Base extensible eICR Processing Status Reason Detail Type (eCR) 📦1 us.cdc.phinvads v0.12
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation eICR Processing Status Reason
Constraints: obs-6, obs-7
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
Observation.code This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR6",
      "display" : "eICR Processing Status Reason"
    }
  ]
}
Observation.subject This element is included in summaries. 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.effective[x] This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
Observation.effective[x].effectiveDateTime dateTime
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Observation.value[x] This element is included in summaries. C 0..1 CodeableConcept Processing status reason
Binding: eICR Processing Status Reason (eCR) (extensible): Processing Status Reason
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Observation.component This element must be supported. This element is included in summaries. 0..* BackboneElement eICR Processing Status Reason Detail
Observation.component.id 0..1 string Unique id for inter-element referencing
Observation.component.extension 0..* Extension Additional content defined by implementations
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of processing status reason detail
Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type
Observation.component.value[x] This element must be supported. This element is included in summaries. 1..1 Processing status reason detail
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.value[x] Base extensible eICR Processing Status Reason (eCR) 📦1 us.cdc.phinvads v0.12
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base extensible eICR Processing Status Reason Detail Type (eCR) 📦1 us.cdc.phinvads v0.12
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.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()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from Observation

Summary

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

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation eICR Processing Status Reason
Constraints: obs-6, obs-7
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.code This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR6",
      "display" : "eICR Processing Status Reason"
    }
  ]
}
Observation.value[x] This element is included in summaries. C 0..1 CodeableConcept Processing status reason
Binding: eICR Processing Status Reason (eCR) (extensible): Processing Status Reason
Observation.component This element must be supported. This element is included in summaries. 0..* BackboneElement eICR Processing Status Reason Detail
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of processing status reason detail
Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type
Observation.component.value[x] This element must be supported. This element is included in summaries. 1..1 Processing status reason detail
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.value[x] Base extensible eICR Processing Status Reason (eCR) 📦1 us.cdc.phinvads v0.12
Observation.component.​code Base extensible eICR Processing Status Reason Detail Type (eCR) 📦1 us.cdc.phinvads v0.12

Constraints

Id Grade Path(s) Description Expression
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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.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()

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* Observation eICR Processing Status Reason
Observation.code 1..1 CodeableConcept Type of observation (code / type)
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR6",
      "display" : "eICR Processing Status Reason"
    }
  ]
}
Observation.value[x] 0..1 CodeableConcept Processing status reason
Binding: eICR Processing Status Reason (eCR) (extensible): Processing Status Reason
Observation.component This element must be supported. 0..* BackboneElement eICR Processing Status Reason Detail
Observation.component.code This element must be supported. 1..1 CodeableConcept Type of processing status reason detail
Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type
Observation.component.value[x] This element must be supported. 1..1 Processing status reason detail
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.value[x] Base extensible eICR Processing Status Reason (eCR) 📦1 us.cdc.phinvads v0.12
Observation.component.​code Base extensible eICR Processing Status Reason Detail Type (eCR) 📦1 us.cdc.phinvads v0.12

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation eICR Processing Status Reason
Constraints: obs-6, obs-7
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
Observation.code This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "urn:oid:2.16.840.1.114222.4.5.232",
      "code" : "RR6",
      "display" : "eICR Processing Status Reason"
    }
  ]
}
Observation.subject This element is included in summaries. 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.effective[x] This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
Observation.effective[x].effectiveDateTime dateTime
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Observation.value[x] This element is included in summaries. C 0..1 CodeableConcept Processing status reason
Binding: eICR Processing Status Reason (eCR) (extensible): Processing Status Reason
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Observation.component This element must be supported. This element is included in summaries. 0..* BackboneElement eICR Processing Status Reason Detail
Observation.component.id 0..1 string Unique id for inter-element referencing
Observation.component.extension 0..* Extension Additional content defined by implementations
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of processing status reason detail
Binding: eICR Processing Status Reason Detail Type (eCR) (extensible): Processing Status Reason Detail Type
Observation.component.value[x] This element must be supported. This element is included in summaries. 1..1 Processing status reason detail
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.value[x] Base extensible eICR Processing Status Reason (eCR) 📦1 us.cdc.phinvads v0.12
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base extensible eICR Processing Status Reason Detail Type (eCR) 📦1 us.cdc.phinvads v0.12
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.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()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from Observation

Summary

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

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron