This page is part of the Quality Improvement Core Framework (v6.0.0-ballot: STU6 (v6.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-simple-observation | Version: 6.0.0-ballot | |||
Active as of 2018-08-22 | Computable Name: QICoreSimpleObservation |
Profile of Simple Observation for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
Note: US-Core and QI-Core define precise profiles for specific observations, as well as a general profile for LOINC-code laboratory result observations. QI-Core inherits these US Core specific profiles directly and individually profiles others. When creating expressions for eCQMs or CDS artifacts with QI-Core for the following clinical data, use the applicable profile directly rather than the generic QICore Observation profile:
As stated in the Home Page, QI Core derives from US Core and so the requirements on “MustSupport” defined in US Core must be respected. QI Core further describes and constrains the “MustSupport” functionality.
To create an expression specifically requesting information that an observation intentionally did not occur for a medical, patient or system reason, use the profile QICore Observation Cancelled.
The following example illustrates the use of the observation profile.
define "Pap Test with Results":
[Observation: "Pap Test"] PapTest
where PapTest.value is not null
and PapTest.status in { 'final', 'amended', 'corrected', 'preliminary' }
Example of a Frailty Observation |
Example of a Gestation Age at Birth Observation |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreSimpleObservationProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | USCoreSimpleObservationProfile | assessment observation | |
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 | registered | prliminary | final | amended | corrected | entered-in-error | unknown Binding: Non-Negative Observation Status (required) |
category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation |
code | S | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred): This value set specifies the type of observation |
subject | SΣ | 1..1 | Reference(QICore Patient) | (USCDI) Who and/or what the observation is about |
effective[x] | SΣ | 0..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime S | |||
effectivePeriod | Period S | |||
effectiveTiming | Timing S | |||
effectiveInstant | instant S | |||
performer | S | 0..* | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) | (USCDI) Who is responsible for the observation |
Slices for value[x] | SΣ | 0..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity S | |||
valueCodeableConcept | CodeableConcept S | |||
valueString | string S | |||
valueBoolean | boolean S | |||
valueInteger | integer S | |||
valueRange | Range S | |||
valueRatio | Ratio S | |||
valueSampledData | SampledData | |||
valueTime | time S | |||
valueDateTime | dateTime S | |||
valuePeriod | Period S | |||
value[x]:valueCodeableConcept | S | 0..1 | CodeableConcept | (USCDI) Actual result Binding: US Core Observation Value Codes (SNOMED-CT) (preferred): SNOMED CT for coded results |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
derivedFrom | 0..* | Reference(QICore Simple Observation | QICore QuestionnaireResponse | US Core DocumentReference Profile | ImagingStudy | Media | MolecularSequence) | (USCDI) US Core Profiles or other resource the observation is made from | |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | NonNegativeObservationStatus |
Observation.code | preferred | LOINCCodes (a valid code from LOINC) |
Observation.value[x]:valueCodeableConcept | preferred | USCoreObservationValueCodes (a valid code from SNOMED CT) |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | USCoreSimpleObservationProfile | assessment observation |
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 | registered | prliminary | final | amended | corrected | entered-in-error | unknown Binding: Non-Negative Observation Status (required) |
Slices for category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
code | SΣ | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred): This value set specifies the type of observation |
subject | SΣ | 1..1 | Reference(QICore Patient) | (USCDI) Who and/or what the observation is about |
effective[x] | SΣ | 0..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
performer | SΣ | 0..* | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) | (USCDI) Who is responsible for the observation |
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
value[x]:valueCodeableConcept | SΣC | 0..1 | CodeableConcept | (USCDI) Actual result Binding: US Core Observation Value Codes (SNOMED-CT) (preferred): SNOMED CT for coded results |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
derivedFrom | Σ | 0..* | Reference(QICore Simple Observation | QICore QuestionnaireResponse | US Core DocumentReference Profile | ImagingStudy | Media | MolecularSequence) | (USCDI) US Core Profiles or other resource the observation is made from |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | NonNegativeObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:us-core | required | USCoreSimpleObservationCategory |
Observation.code | preferred | LOINCCodes (a valid code from LOINC) |
Observation.value[x]:valueCodeableConcept | preferred | USCoreObservationValueCodes (a valid code from SNOMED CT) |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Id | Grade | Path(s) | 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() | |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | USCoreSimpleObservationProfile | assessment observation | ||||
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.
| |||||
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 | registered | prliminary | final | amended | corrected | entered-in-error | unknown Binding: Non-Negative Observation Status (required) | ||||
Slices for category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets | ||||
code | SΣ | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred): This value set specifies the type of observation | ||||
subject | SΣ | 1..1 | Reference(QICore Patient) | (USCDI) Who and/or what the observation is about | ||||
focus | ΣTU | 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Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
effectiveDateTime | dateTime S | |||||||
effectivePeriod | Period S | |||||||
effectiveTiming | Timing S | |||||||
effectiveInstant | instant S | |||||||
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) | (USCDI) Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||
valueQuantity | Quantity S | |||||||
valueCodeableConcept | CodeableConcept S | |||||||
valueString | string S | |||||||
valueBoolean | boolean S | |||||||
valueInteger | integer S | |||||||
valueRange | Range S | |||||||
valueRatio | Ratio S | |||||||
valueSampledData | SampledData | |||||||
valueTime | time S | |||||||
valueDateTime | dateTime S | |||||||
valuePeriod | Period S | |||||||
value[x]:valueCodeableConcept | SΣC | 0..1 | CodeableConcept | (USCDI) Actual result Binding: US Core Observation Value Codes (SNOMED-CT) (preferred): SNOMED CT for coded results | ||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | S | 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 | C | 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 | 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 | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
derivedFrom | Σ | 0..* | Reference(QICore Simple Observation | QICore QuestionnaireResponse | US Core DocumentReference Profile | ImagingStudy | Media | MolecularSequence) | (USCDI) US Core Profiles or other resource 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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | NonNegativeObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.category:us-core | required | USCoreSimpleObservationCategory | ||||
Observation.code | preferred | LOINCCodes (a valid code from LOINC) | ||||
Observation.value[x]:valueCodeableConcept | preferred | USCoreObservationValueCodes (a valid code from SNOMED CT) | ||||
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 | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from USCoreSimpleObservationProfile
Summary
Mandatory: 2 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCoreSimpleObservationProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | USCoreSimpleObservationProfile | assessment observation | |
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 | registered | prliminary | final | amended | corrected | entered-in-error | unknown Binding: Non-Negative Observation Status (required) |
category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation |
code | S | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred): This value set specifies the type of observation |
subject | SΣ | 1..1 | Reference(QICore Patient) | (USCDI) Who and/or what the observation is about |
effective[x] | SΣ | 0..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime S | |||
effectivePeriod | Period S | |||
effectiveTiming | Timing S | |||
effectiveInstant | instant S | |||
performer | S | 0..* | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) | (USCDI) Who is responsible for the observation |
Slices for value[x] | SΣ | 0..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity S | |||
valueCodeableConcept | CodeableConcept S | |||
valueString | string S | |||
valueBoolean | boolean S | |||
valueInteger | integer S | |||
valueRange | Range S | |||
valueRatio | Ratio S | |||
valueSampledData | SampledData | |||
valueTime | time S | |||
valueDateTime | dateTime S | |||
valuePeriod | Period S | |||
value[x]:valueCodeableConcept | S | 0..1 | CodeableConcept | (USCDI) Actual result Binding: US Core Observation Value Codes (SNOMED-CT) (preferred): SNOMED CT for coded results |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
derivedFrom | 0..* | Reference(QICore Simple Observation | QICore QuestionnaireResponse | US Core DocumentReference Profile | ImagingStudy | Media | MolecularSequence) | (USCDI) US Core Profiles or other resource the observation is made from | |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | NonNegativeObservationStatus |
Observation.code | preferred | LOINCCodes (a valid code from LOINC) |
Observation.value[x]:valueCodeableConcept | preferred | USCoreObservationValueCodes (a valid code from SNOMED CT) |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | USCoreSimpleObservationProfile | assessment observation |
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 | registered | prliminary | final | amended | corrected | entered-in-error | unknown Binding: Non-Negative Observation Status (required) |
Slices for category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
code | SΣ | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred): This value set specifies the type of observation |
subject | SΣ | 1..1 | Reference(QICore Patient) | (USCDI) Who and/or what the observation is about |
effective[x] | SΣ | 0..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
performer | SΣ | 0..* | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore CareTeam | QICore RelatedPerson) | (USCDI) Who is responsible for the observation |
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueTime | time | |||
valueDateTime | dateTime | |||
valuePeriod | Period | |||
value[x]:valueCodeableConcept | SΣC | 0..1 | CodeableConcept | (USCDI) Actual result Binding: US Core Observation Value Codes (SNOMED-CT) (preferred): SNOMED CT for coded results |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
derivedFrom | Σ | 0..* | Reference(QICore Simple Observation | QICore QuestionnaireResponse | US Core DocumentReference Profile | ImagingStudy | Media | MolecularSequence) | (USCDI) US Core Profiles or other resource the observation is made from |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | NonNegativeObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:us-core | required | USCoreSimpleObservationCategory |
Observation.code | preferred | LOINCCodes (a valid code from LOINC) |
Observation.value[x]:valueCodeableConcept | preferred | USCoreObservationValueCodes (a valid code from SNOMED CT) |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Id | Grade | Path(s) | 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() | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | USCoreSimpleObservationProfile | assessment observation | ||||
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.
| |||||
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 | registered | prliminary | final | amended | corrected | entered-in-error | unknown Binding: Non-Negative Observation Status (required) | ||||
Slices for category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets | ||||
code | SΣ | 1..1 | CodeableConcept | (USCDI) Type of observation (code / type) Binding: LOINCCodes (preferred): This value set specifies the type of observation | ||||
subject | SΣ | 1..1 | Reference(QICore Patient) | (USCDI) Who and/or what the observation is about | ||||
focus | ΣTU | 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Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
effectiveDateTime | dateTime S | |||||||
effectivePeriod | Period S | |||||||
effectiveTiming | Timing S | |||||||
effectiveInstant | instant S | |||||||
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) | (USCDI) Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||
valueQuantity | Quantity S | |||||||
valueCodeableConcept | CodeableConcept S | |||||||
valueString | string S | |||||||
valueBoolean | boolean S | |||||||
valueInteger | integer S | |||||||
valueRange | Range S | |||||||
valueRatio | Ratio S | |||||||
valueSampledData | SampledData | |||||||
valueTime | time S | |||||||
valueDateTime | dateTime S | |||||||
valuePeriod | Period S | |||||||
value[x]:valueCodeableConcept | SΣC | 0..1 | CodeableConcept | (USCDI) Actual result Binding: US Core Observation Value Codes (SNOMED-CT) (preferred): SNOMED CT for coded results | ||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | S | 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 | C | 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 | 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 | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
derivedFrom | Σ | 0..* | Reference(QICore Simple Observation | QICore QuestionnaireResponse | US Core DocumentReference Profile | ImagingStudy | Media | MolecularSequence) | (USCDI) US Core Profiles or other resource 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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | NonNegativeObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.category:us-core | required | USCoreSimpleObservationCategory | ||||
Observation.code | preferred | LOINCCodes (a valid code from LOINC) | ||||
Observation.value[x]:valueCodeableConcept | preferred | USCoreObservationValueCodes (a valid code from SNOMED CT) | ||||
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 | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from USCoreSimpleObservationProfile
Summary
Mandatory: 2 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron