QI-Core Implementation Guide
7.0.0 - STU7 United States of America flag

QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions

Resource Profile: QICore Observation Screening Assessment

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-observation-screening-assessment Version: 7.0.0
Active as of 2022-04-20 Computable Name: QICoreObservationScreeningAssessment

The QI-Core Observation Screening Assessment Profile is based upon the US Core Observation Screening Assessment Profile which can be used to represent individual responses, panels of multi-question surveys, and multi-select responses to “check all that apply” questions. The QI-Core Observation Survey Profile sets minimum expectations for the Observation Resource to record, search, and fetch retrieve observations that represent the questions and responses to form/survey and defines the core set of elements and extensions for quality rule and measure authors.

Contents:

Must Have:
  • status: (QI) registered | prliminary | final | amended | corrected | entered-in-error | unknown
  • category: (QI) Classification of type of observation
  • category: (QI) Classification of type of observation
  • code: (QI) Type of observation (code / type)
  • subject: (QI) Who and/or what the observation is about
QI Elements:
  • category: (QI) Classification of type of observation
  • effective[x]: (QI) Clinically relevant time/time-period for observation
  • performer: (QI) Who is responsible for the observation
  • value[x]: (QI) Actual result
  • dataAbsentReason: (QI) Why the result is missing
  • interpretation: (QI) High, low, normal, etc.
  • hasMember: (QI) Reference to panel or multi-select responses
  • derivedFrom: (QI) Related Observations or QuestionnaireResponses that the observation is made from
Primary code path: code
(PCPath) This element is the primary code path for this resource CQL Retrieve


NOTE TO BALLOT REVIEWERS:
  • US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.
    • As noted in the US Core 7.0 Must Support section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.
    • Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.
  • We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.
  • Further, QI-Core 7.0 does not discuss USCDI+Quality because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.

Guidance

Reference Guidance for use of the Observation Screening Assessment profile can be found here.

  • See the Social Determinants of Health (SDOH) Guidance Page for how this profile along with other Observation Profiles or alternatively QuestionnaireResponse to is used represent SDOH assessments.

Usage

See the patterns page for implementation and usage patterns.

Examples

10 minute Apgar Heart Rate Example

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreObservationScreeningAssessmentProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* USCoreObservationScreeningAssessmentProfile Survey Observation
... status 1..1 code (QI) registered | prliminary | final | amended | corrected | entered-in-error | unknown
Binding: Non-Negative Observation Status (required)
... Slices for category 1..* CodeableConcept (QI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.


.... category:survey 1..1 CodeableConcept (QI) Classification of type of observation
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.



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: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: survey
.... category:screening-assessment 0..* CodeableConcept (QI) Classification of type of observation
Binding: US Core Screening Assessment Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code Σ 1..1 CodeableConcept (QI) Type of observation (code / type)
Binding: US Core Survey Codes (preferred)
... effective[x] Σ 0..1 (QI) Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer 0..* Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) (QI) Who is responsible for the observation
... value[x] 0..1 (QI) Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason 0..1 CodeableConcept (QI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept (QI) High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... hasMember 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Reference to panel or multi-select responses
... derivedFrom 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Related Observations or QuestionnaireResponses that the observation is made from

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Observation.statusrequiredNonNegativeObservationStatus
http://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-observation-status
from this IG
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:surveyrequiredPattern: survey
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:screening-assessmentrequiredUSCoreScreeningAssessmentObservationCategory
http://hl7.org/fhir/us/core/ValueSet/us-core-screening-assessment-observation-category
Observation.codepreferredUSCoreSurveyCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-survey-codes
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* USCoreObservationScreeningAssessmentProfile Survey Observation
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code (QI) registered | prliminary | final | amended | corrected | entered-in-error | unknown
Binding: Non-Negative Observation Status (required)
.... category:survey S 1..1 CodeableConcept (QI) Classification of type of observation
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.



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: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: survey
.... category:screening-assessment S 0..* CodeableConcept (QI) Classification of type of observation
Binding: US Core Screening Assessment Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code SΣ 1..1 CodeableConcept (QI) Type of observation (code / type)
Binding: US Core Survey Codes (preferred)
... subject SΣ 1..1 Reference(QICore Patient | QICore Location) (QI) Who and/or what the observation is about
... effective[x] SΣC 0..1 (QI) Clinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
.... effectiveDateTime dateTime
... performer SΣ 0..* Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) (QI) Who is responsible for the observation
... value[x] SΣC 0..1 (QI) Actual result
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
... dataAbsentReason SC 0..1 CodeableConcept (QI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept (QI) High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... hasMember SΣ 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Reference to panel or multi-select responses
... derivedFrom SΣ 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Related Observations or QuestionnaireResponses that the observation is made from

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredNonNegativeObservationStatus
http://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-observation-status
from this IG
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:surveyrequiredPattern: survey
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:screening-assessmentrequiredUSCoreScreeningAssessmentObservationCategory
http://hl7.org/fhir/us/core/ValueSet/us-core-screening-assessment-observation-category
Observation.codepreferredUSCoreSurveyCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-survey-codes
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()
us-core-1errorObservation.effective[x]Datetime must be at least to day.
: $this is dateTime implies $this.toString().length() >= 10
us-core-2errorObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
us-core-3errorObservation.value[x]SHALL use UCUM for coded quantity units.
: ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* USCoreObservationScreeningAssessmentProfile Survey Observation
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code (QI) registered | prliminary | final | amended | corrected | entered-in-error | unknown
Binding: Non-Negative Observation Status (required)
... Slices for category S 1..* CodeableConcept (QI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.


.... category:survey S 1..1 CodeableConcept (QI) Classification of type of observation
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.



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: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: survey
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:screening-assessment S 0..* CodeableConcept (QI) Classification of type of observation
Binding: US Core Screening Assessment Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code SΣ 1..1 CodeableConcept (QI) Type of observation (code / type)
Binding: US Core Survey Codes (preferred)
... subject SΣ 1..1 Reference(QICore Patient | QICore Location) (QI) 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] SΣC 0..1 (QI) Clinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) (QI) Who is responsible for the observation
... value[x] SΣC 0..1 (QI) Actual result
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason SC 0..1 CodeableConcept (QI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept (QI) 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 C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... 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 C 0..1 SimpleQuantity Low Range, if relevant
.... high C 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 SΣ 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Reference to panel or multi-select responses
... derivedFrom SΣ 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Related Observations or QuestionnaireResponses that the observation is made from
... component Σ 0..* BackboneElement Component results
.... 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 Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredNonNegativeObservationStatus
http://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-observation-status
from this IG
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:surveyrequiredPattern: survey
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:screening-assessmentrequiredUSCoreScreeningAssessmentObservationCategory
http://hl7.org/fhir/us/core/ValueSet/us-core-screening-assessment-observation-category
Observation.codepreferredUSCoreSurveyCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-survey-codes
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()
us-core-1errorObservation.effective[x]Datetime must be at least to day.
: $this is dateTime implies $this.toString().length() >= 10
us-core-2errorObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
us-core-3errorObservation.value[x]SHALL use UCUM for coded quantity units.
: ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'

Differential View

This structure is derived from USCoreObservationScreeningAssessmentProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* USCoreObservationScreeningAssessmentProfile Survey Observation
... status 1..1 code (QI) registered | prliminary | final | amended | corrected | entered-in-error | unknown
Binding: Non-Negative Observation Status (required)
... Slices for category 1..* CodeableConcept (QI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.


.... category:survey 1..1 CodeableConcept (QI) Classification of type of observation
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.



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: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: survey
.... category:screening-assessment 0..* CodeableConcept (QI) Classification of type of observation
Binding: US Core Screening Assessment Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code Σ 1..1 CodeableConcept (QI) Type of observation (code / type)
Binding: US Core Survey Codes (preferred)
... effective[x] Σ 0..1 (QI) Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer 0..* Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) (QI) Who is responsible for the observation
... value[x] 0..1 (QI) Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason 0..1 CodeableConcept (QI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept (QI) High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... hasMember 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Reference to panel or multi-select responses
... derivedFrom 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Related Observations or QuestionnaireResponses that the observation is made from

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Observation.statusrequiredNonNegativeObservationStatus
http://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-observation-status
from this IG
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:surveyrequiredPattern: survey
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:screening-assessmentrequiredUSCoreScreeningAssessmentObservationCategory
http://hl7.org/fhir/us/core/ValueSet/us-core-screening-assessment-observation-category
Observation.codepreferredUSCoreSurveyCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-survey-codes
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* USCoreObservationScreeningAssessmentProfile Survey Observation
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code (QI) registered | prliminary | final | amended | corrected | entered-in-error | unknown
Binding: Non-Negative Observation Status (required)
.... category:survey S 1..1 CodeableConcept (QI) Classification of type of observation
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.



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: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: survey
.... category:screening-assessment S 0..* CodeableConcept (QI) Classification of type of observation
Binding: US Core Screening Assessment Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code SΣ 1..1 CodeableConcept (QI) Type of observation (code / type)
Binding: US Core Survey Codes (preferred)
... subject SΣ 1..1 Reference(QICore Patient | QICore Location) (QI) Who and/or what the observation is about
... effective[x] SΣC 0..1 (QI) Clinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
.... effectiveDateTime dateTime
... performer SΣ 0..* Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) (QI) Who is responsible for the observation
... value[x] SΣC 0..1 (QI) Actual result
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
... dataAbsentReason SC 0..1 CodeableConcept (QI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept (QI) High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... hasMember SΣ 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Reference to panel or multi-select responses
... derivedFrom SΣ 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Related Observations or QuestionnaireResponses that the observation is made from

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredNonNegativeObservationStatus
http://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-observation-status
from this IG
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:surveyrequiredPattern: survey
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:screening-assessmentrequiredUSCoreScreeningAssessmentObservationCategory
http://hl7.org/fhir/us/core/ValueSet/us-core-screening-assessment-observation-category
Observation.codepreferredUSCoreSurveyCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-survey-codes
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()
us-core-1errorObservation.effective[x]Datetime must be at least to day.
: $this is dateTime implies $this.toString().length() >= 10
us-core-2errorObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
us-core-3errorObservation.value[x]SHALL use UCUM for coded quantity units.
: ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* USCoreObservationScreeningAssessmentProfile Survey Observation
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code (QI) registered | prliminary | final | amended | corrected | entered-in-error | unknown
Binding: Non-Negative Observation Status (required)
... Slices for category S 1..* CodeableConcept (QI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.


.... category:survey S 1..1 CodeableConcept (QI) Classification of type of observation
Binding: ObservationCategoryCodes (required): Codes for high level observation categories.



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: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: survey
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:screening-assessment S 0..* CodeableConcept (QI) Classification of type of observation
Binding: US Core Screening Assessment Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code SΣ 1..1 CodeableConcept (QI) Type of observation (code / type)
Binding: US Core Survey Codes (preferred)
... subject SΣ 1..1 Reference(QICore Patient | QICore Location) (QI) 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] SΣC 0..1 (QI) Clinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) (QI) Who is responsible for the observation
... value[x] SΣC 0..1 (QI) Actual result
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason SC 0..1 CodeableConcept (QI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept (QI) 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 C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... 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 C 0..1 SimpleQuantity Low Range, if relevant
.... high C 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 SΣ 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Reference to panel or multi-select responses
... derivedFrom SΣ 0..* Reference(QICore Observation Screening Assessment | QICore QuestionnaireResponse) (QI) Related Observations or QuestionnaireResponses that the observation is made from
... component Σ 0..* BackboneElement Component results
.... 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 Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredNonNegativeObservationStatus
http://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-observation-status
from this IG
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:surveyrequiredPattern: survey
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:screening-assessmentrequiredUSCoreScreeningAssessmentObservationCategory
http://hl7.org/fhir/us/core/ValueSet/us-core-screening-assessment-observation-category
Observation.codepreferredUSCoreSurveyCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-survey-codes
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()
us-core-1errorObservation.effective[x]Datetime must be at least to day.
: $this is dateTime implies $this.toString().length() >= 10
us-core-2errorObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
us-core-3errorObservation.value[x]SHALL use UCUM for coded quantity units.
: ofType(Quantity).system.empty() or ofType(Quantity).system = 'http://unitsofmeasure.org'

 

Other representations of profile: CSV, Excel, Schematron