SDOH Clinical Care
3.1.0 - STU 3.1 Draft United States of America flag

SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-sdoh-clinicalcare/ and changes regularly. See the Directory of published versions

Resource Profile: SDOHCC Observation Assessment

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationAssessment Version: 3.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: SDOHCCObservationAssessment
Other Identifiers: OID:2.16.840.1.113883.4.642.40.6.42.11

Profile for Social Determinants of Health (SDOH) observations that involve assessment (e.g., by a provider, payer, etc.) as opposed to being derived only from screening surveys (as is the case for the SDOHCC Screening Response Observation).

Purpose

SDOHCC Observation Assessment is intended for social risk-related Observations that involve an assessment (e.g., by a provider, payer, etc.) rather than being derived only from question-answer pairs on assessment instruments (as is the case for SDOHCC Observation Screening Response).

Usage

The Observation.category slice with binding to SDOHCC ValueSet SDOH Category allows categorization of the Observation into an SDOH category (domain). However, unlike SDOHCC Observation Screening Response, this profile does not have Gravity-vetted, preferred value sets in VSAC. This was intentional so as not to constrain the social risk observations that a provider might make about an individual.

Of note, Gravity Project is continuously developing terminology for new SDOH domains, and some SDOH domains may not yet be represented in SDOHCC ValueSet SDOH Category. In this case, Observation.category: sdoh-category-unspecified can be used and Observation.category.text can be added to further specify the domain. For example, at the time of publication of this IG, “disability-status” is not yet included in SDOHCC ValueSet SDOH Category. In this case, Observation.category: sdoh-category-unspecified can be used along with Observation.category.text: Disability Status.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USCoreSimpleObservationProfile(7.0.0) SDOH assessment observation
Constraints: obs-6, obs-7, us-core-2, SDOH-Obs-4
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.Slices for category This element must be supported. 1..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for category.category:us-core This element must be supported. C 1..* CodeableConcept Requires at least a category code 'sdoh'
Binding: USCoreSimpleObservationCategory (8.0.1) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
Observation.Slices for category.category:SDOHCC This element must be supported. 0..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0) | Group) Who and/or what the observation is about
Observation.effective[x] This element must be supported. This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
Observation.effective[x].effectiveDateTime dateTime This target must be supported.
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(US Core RelatedPerson Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 Actual result
Observation.value[x].valueQuantity Quantity This type must be supported.
Observation.value[x].valueCodeableConcept CodeableConcept This type must be supported.
Observation.value[x].valueString string This target must be supported.
Observation.value[x].valueBoolean boolean This target must be supported.
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.derivedFrom This element is included in summaries. 0..* Reference(Observation | US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | ImagingStudy | Media | MolecularSequence) ADDITIONAL USCDI: US Core Profiles or other resource the observation is made from

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred SDOHCC ValueSet LOINC SNOMEDCT 📦3.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
SDOH-Obs-4 error Observation At least one Observation.category SHALL be sdoh category.where(coding.where(system = 'http://hl7.org/fhir/us/core/CodeSystem/us-core-category' and code='sdoh').exists()).exists()
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-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())

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USCoreSimpleObservationProfile(7.0.0) SDOH assessment observation
Constraints: us-core-2, SDOH-Obs-4
Observation.Slices for category Content/Rules for all slices
Observation.Slices for category.category:us-core C 1..* CodeableConcept Requires at least a category code 'sdoh'
Observation.Slices for category.category:SDOHCC This element must be supported. 0..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
Observation.code 1..1 CodeableConcept Type of observation (code / type)
Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred)
Observation.subject 1..1 Reference(US Core Patient Profile(7.0.0) | Group) Who and/or what the observation is about
Observation.performer 0..* Reference(US Core RelatedPerson Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Who is responsible for the observation
Observation.derivedFrom 0..* Reference(Observation | US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | ImagingStudy | Media | MolecularSequence) ADDITIONAL USCDI: US Core Profiles or other resource the observation is made from

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred SDOHCC ValueSet LOINC SNOMEDCT 📦3.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
SDOH-Obs-4 error Observation At least one Observation.category SHALL be sdoh category.where(coding.where(system = 'http://hl7.org/fhir/us/core/CodeSystem/us-core-category' and code='sdoh').exists()).exists()
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())
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USCoreSimpleObservationProfile(7.0.0) SDOH assessment observation
Constraints: obs-6, obs-7, us-core-2, SDOH-Obs-4
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.Slices for category This element must be supported. 1..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for category.category:us-core This element must be supported. C 1..* CodeableConcept Requires at least a category code 'sdoh'
Binding: USCoreSimpleObservationCategory (8.0.1) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
Observation.Slices for category.category:SDOHCC This element must be supported. 0..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0) | Group) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.effective[x] This element must be supported. This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
Observation.effective[x].effectiveDateTime dateTime This target must be supported.
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(US Core RelatedPerson Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 Actual result
Observation.value[x].valueQuantity Quantity This type must be supported.
Observation.value[x].valueCodeableConcept CodeableConcept This type must be supported.
Observation.value[x].valueString string This target must be supported.
Observation.value[x].valueBoolean boolean This target must be supported.
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(Observation | US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | ImagingStudy | Media | MolecularSequence) ADDITIONAL USCDI: US Core Profiles or other resource the observation is made from
Observation.component This element is included in summaries. 0..* BackboneElement Component results
Observation.component.id 0..1 string Unique id for inter-element referencing
Observation.component.extension 0..* Extension Additional content defined by implementations
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.component.value[x] This element is included in summaries. 0..1 Actual component result
Observation.component.value[x].valueQuantity Quantity
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.value[x].valueBoolean boolean
Observation.component.value[x].valueInteger integer
Observation.component.value[x].valueRange Range
Observation.component.value[x].valueRatio Ratio
Observation.component.value[x].valueSampledData SampledData
Observation.component.value[x].valueTime time
Observation.component.value[x].valueDateTime dateTime
Observation.component.value[x].valuePeriod Period
Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred SDOHCC ValueSet LOINC SNOMEDCT 📦3.1.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📦4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📦4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
SDOH-Obs-4 error Observation At least one Observation.category SHALL be sdoh category.where(coding.where(system = 'http://hl7.org/fhir/us/core/CodeSystem/us-core-category' and code='sdoh').exists()).exists()
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()
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())

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USCoreSimpleObservationProfile(7.0.0) SDOH assessment observation
Constraints: obs-6, obs-7, us-core-2, SDOH-Obs-4
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.Slices for category This element must be supported. 1..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for category.category:us-core This element must be supported. C 1..* CodeableConcept Requires at least a category code 'sdoh'
Binding: USCoreSimpleObservationCategory (8.0.1) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
Observation.Slices for category.category:SDOHCC This element must be supported. 0..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0) | Group) Who and/or what the observation is about
Observation.effective[x] This element must be supported. This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
Observation.effective[x].effectiveDateTime dateTime This target must be supported.
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(US Core RelatedPerson Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 Actual result
Observation.value[x].valueQuantity Quantity This type must be supported.
Observation.value[x].valueCodeableConcept CodeableConcept This type must be supported.
Observation.value[x].valueString string This target must be supported.
Observation.value[x].valueBoolean boolean This target must be supported.
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.derivedFrom This element is included in summaries. 0..* Reference(Observation | US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | ImagingStudy | Media | MolecularSequence) ADDITIONAL USCDI: US Core Profiles or other resource the observation is made from

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred SDOHCC ValueSet LOINC SNOMEDCT 📦3.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
SDOH-Obs-4 error Observation At least one Observation.category SHALL be sdoh category.where(coding.where(system = 'http://hl7.org/fhir/us/core/CodeSystem/us-core-category' and code='sdoh').exists()).exists()
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-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())

Differential View

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USCoreSimpleObservationProfile(7.0.0) SDOH assessment observation
Constraints: us-core-2, SDOH-Obs-4
Observation.Slices for category Content/Rules for all slices
Observation.Slices for category.category:us-core C 1..* CodeableConcept Requires at least a category code 'sdoh'
Observation.Slices for category.category:SDOHCC This element must be supported. 0..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
Observation.code 1..1 CodeableConcept Type of observation (code / type)
Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred)
Observation.subject 1..1 Reference(US Core Patient Profile(7.0.0) | Group) Who and/or what the observation is about
Observation.effective[x] 0..1 dateTime, Period, Timing, instant Clinically relevant time/time-period for observation
Observation.performer 0..* Reference(US Core RelatedPerson Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Who is responsible for the observation
Observation.derivedFrom 0..* Reference(Observation | US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | ImagingStudy | Media | MolecularSequence) ADDITIONAL USCDI: US Core Profiles or other resource the observation is made from

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred SDOHCC ValueSet LOINC SNOMEDCT 📦3.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
SDOH-Obs-4 error Observation At least one Observation.category SHALL be sdoh category.where(coding.where(system = 'http://hl7.org/fhir/us/core/CodeSystem/us-core-category' and code='sdoh').exists()).exists()
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())

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USCoreSimpleObservationProfile(7.0.0) SDOH assessment observation
Constraints: obs-6, obs-7, us-core-2, SDOH-Obs-4
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.Slices for category This element must be supported. 1..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for category.category:us-core This element must be supported. C 1..* CodeableConcept Requires at least a category code 'sdoh'
Binding: USCoreSimpleObservationCategory (8.0.1) (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
Observation.Slices for category.category:SDOHCC This element must be supported. 0..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0) | Group) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.effective[x] This element must be supported. This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
Observation.effective[x].effectiveDateTime dateTime This target must be supported.
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(US Core RelatedPerson Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core Practitioner Profile(7.0.0) | SDOHCC PractitionerRole | US Core Organization Profile(7.0.0) | US Core CareTeam Profile(7.0.0)) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 Actual result
Observation.value[x].valueQuantity Quantity This type must be supported.
Observation.value[x].valueCodeableConcept CodeableConcept This type must be supported.
Observation.value[x].valueString string This target must be supported.
Observation.value[x].valueBoolean boolean This target must be supported.
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(Observation | US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | ImagingStudy | Media | MolecularSequence) ADDITIONAL USCDI: US Core Profiles or other resource the observation is made from
Observation.component This element is included in summaries. 0..* BackboneElement Component results
Observation.component.id 0..1 string Unique id for inter-element referencing
Observation.component.extension 0..* Extension Additional content defined by implementations
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.component.value[x] This element is included in summaries. 0..1 Actual component result
Observation.component.value[x].valueQuantity Quantity
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.value[x].valueBoolean boolean
Observation.component.value[x].valueInteger integer
Observation.component.value[x].valueRange Range
Observation.component.value[x].valueRatio Ratio
Observation.component.value[x].valueSampledData SampledData
Observation.component.value[x].valueTime time
Observation.component.value[x].valueDateTime dateTime
Observation.component.value[x].valuePeriod Period
Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred SDOHCC ValueSet LOINC SNOMEDCT 📦3.1.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📦4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📦4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
SDOH-Obs-4 error Observation At least one Observation.category SHALL be sdoh category.where(coding.where(system = 'http://hl7.org/fhir/us/core/CodeSystem/us-core-category' and code='sdoh').exists()).exists()
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()
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())

 

Other representations of profile: CSV, Excel, Schematron