This page is part of the MCC eCare Plan Implementation Guide (v1.0.0-ballot2: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/mcc/StructureDefinition/MCCClinicalResultObservation | Version: 1.0.0-ballot2 | |||
Active as of 2023-07-28 | Computable Name: MCCClinicalResultObservation |
This profile constrains US Core Clinical Result Observation Profile for use in the MCC FHIR Care Plan or other FHIR Care Plans. It is using Observation resource to record, search, and fetch Observations where the Observation is neither a laboratory, imaging, vital sign, social history, sexual orientation, survey, SDOH assessment, nor a smoking status observation. ‘Echocardiogram’ is an example observation which would use the MCC Clinical Result profile.
The US Core Clinical Result Observation Profile sets minimum expectations for the Observation resource to record, search, and fetch Observations where the Observation is neither a laboratory, imaging, vital sign, social history, sexual orientation, survey, SDOH assessment, nor a smoking status observation. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile. In addition to the requirements set forth in US Core profile this derived profile is designed to add requirements to the following elements:
MCC Value sets that may be used with this profile are found on the MCC Clinical Test Value Set library page. Other value sets are not precluded.
Comments are welcome with respect to the pragmatic use of the “Must Support” rules defined on these elements.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreObservationClinicalResultProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | USCoreObservationClinicalResultProfile | Measurements and simple assertions | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
status | S | 1..1 | code | (USCDI) registered | preliminary | final | amended + |
category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation |
code | S | 1..1 | CodeableConcept | Please see the Clinical Test Value Set Library for value sets that are subsets of US Core Observation Code that can be used at Observation.code element |
subject | S | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who and/or what the observation is about |
effective[x] | S | 0..1 | dateTime S, Period, Timing, instant | (USCDI) Clinically relevant time/time-period for observation |
value[x] | S | 0..1 | Quantity S, CodeableConcept S, string S, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | (USCDI) Result Value |
dataAbsentReason | S | 0..1 | CodeableConcept | (USCDI) Why the result is missing |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | USCoreObservationClinicalResultProfile | Measurements and simple assertions |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
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 Clinical Result Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
code | SΣ | 1..1 | CodeableConcept | Please see the Clinical Test Value Set Library for value sets that are subsets of US Core Observation Code that can be used at Observation.code element Binding: LOINCCodes (extensible) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who and/or what the observation is about |
effective[x] | SΣC | 0..1 | (USCDI) Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
value[x] | SΣC | 0..1 | (USCDI) Result Value | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
dataAbsentReason | SC | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:us-core | required | USCoreClinicalResultObservationCategory |
Observation.code | extensible | LOINCCodes (a valid code from LOINC) |
Observation.dataAbsentReason | extensible | DataAbsentReason |
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() | |
us-core-1 | error | Observation.effective[x] | Datetime must be at least to day. : $this is DateTime implies $this.toString().length() >= 10 | |
us-core-2 | error | Observation | If 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-3 | error | Observation.value[x] | SHALL use UCUM for coded quantity units. : value.ofType(Quantity).system.empty() or value.ofType(Quantity).system = 'http://unitsofmeasure.org' |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | USCoreObservationClinicalResultProfile | Measurements and simple assertions | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
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 | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
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 Clinical Result Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets | ||||
code | SΣ | 1..1 | CodeableConcept | Please see the Clinical Test Value Set Library for value sets that are subsets of US Core Observation Code that can be used at Observation.code element Binding: LOINCCodes (extensible) | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | (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ΣC | 0..1 | (USCDI) Clinically relevant time/time-period for observation | |||||
effectiveDateTime | dateTime S | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
effectiveInstant | instant | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
value[x] | SΣC | 0..1 | (USCDI) Result Value | |||||
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 | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
note | 0..* | Annotation | Comments about the observation | |||||
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
referenceRange | 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(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements 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 | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.category:us-core | required | USCoreClinicalResultObservationCategory | ||||
Observation.code | extensible | LOINCCodes (a valid code from LOINC) | ||||
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() | |
us-core-1 | error | Observation.effective[x] | Datetime must be at least to day. : $this is DateTime implies $this.toString().length() >= 10 | |
us-core-3 | error | Observation.value[x] | SHALL use UCUM for coded quantity units. : value.ofType(Quantity).system.empty() or value.ofType(Quantity).system = 'http://unitsofmeasure.org' |
This structure is derived from USCoreObservationClinicalResultProfile
Differential View
This structure is derived from USCoreObservationClinicalResultProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | USCoreObservationClinicalResultProfile | Measurements and simple assertions | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
status | S | 1..1 | code | (USCDI) registered | preliminary | final | amended + |
category | S | 1..* | CodeableConcept | (USCDI) Classification of type of observation |
code | S | 1..1 | CodeableConcept | Please see the Clinical Test Value Set Library for value sets that are subsets of US Core Observation Code that can be used at Observation.code element |
subject | S | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who and/or what the observation is about |
effective[x] | S | 0..1 | dateTime S, Period, Timing, instant | (USCDI) Clinically relevant time/time-period for observation |
value[x] | S | 0..1 | Quantity S, CodeableConcept S, string S, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | (USCDI) Result Value |
dataAbsentReason | S | 0..1 | CodeableConcept | (USCDI) Why the result is missing |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | USCoreObservationClinicalResultProfile | Measurements and simple assertions |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
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 Clinical Result Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
code | SΣ | 1..1 | CodeableConcept | Please see the Clinical Test Value Set Library for value sets that are subsets of US Core Observation Code that can be used at Observation.code element Binding: LOINCCodes (extensible) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who and/or what the observation is about |
effective[x] | SΣC | 0..1 | (USCDI) Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
value[x] | SΣC | 0..1 | (USCDI) Result Value | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
dataAbsentReason | SC | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:us-core | required | USCoreClinicalResultObservationCategory |
Observation.code | extensible | LOINCCodes (a valid code from LOINC) |
Observation.dataAbsentReason | extensible | DataAbsentReason |
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() | |
us-core-1 | error | Observation.effective[x] | Datetime must be at least to day. : $this is DateTime implies $this.toString().length() >= 10 | |
us-core-2 | error | Observation | If 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-3 | error | Observation.value[x] | SHALL use UCUM for coded quantity units. : value.ofType(Quantity).system.empty() or value.ofType(Quantity).system = 'http://unitsofmeasure.org' |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | USCoreObservationClinicalResultProfile | Measurements and simple assertions | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
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 | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
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 Clinical Result Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets | ||||
code | SΣ | 1..1 | CodeableConcept | Please see the Clinical Test Value Set Library for value sets that are subsets of US Core Observation Code that can be used at Observation.code element Binding: LOINCCodes (extensible) | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | (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ΣC | 0..1 | (USCDI) Clinically relevant time/time-period for observation | |||||
effectiveDateTime | dateTime S | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
effectiveInstant | instant | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
value[x] | SΣC | 0..1 | (USCDI) Result Value | |||||
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 | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
note | 0..* | Annotation | Comments about the observation | |||||
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
referenceRange | 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(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements 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 | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.category:us-core | required | USCoreClinicalResultObservationCategory | ||||
Observation.code | extensible | LOINCCodes (a valid code from LOINC) | ||||
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() | |
us-core-1 | error | Observation.effective[x] | Datetime must be at least to day. : $this is DateTime implies $this.toString().length() >= 10 | |
us-core-3 | error | Observation.value[x] | SHALL use UCUM for coded quantity units. : value.ofType(Quantity).system.empty() or value.ofType(Quantity).system = 'http://unitsofmeasure.org' |
This structure is derived from USCoreObservationClinicalResultProfile
Other representations of profile: CSV, Excel, Schematron