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 Program Enrollment Status

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationProgramEnrollmentStatus Version: 3.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: SDOHCCObservationProgramEnrollmentStatus
Other Identifiers: OID:2.16.840.1.113883.4.642.40.6.42.16

For observations about an individual's enrollment status in a social care program. See Enrollment Status for more additional guidance.

The SDOHCC Observation Program Enrollment Status profile is the primary resource used to convey an individual's enrollment status.

  • Observation.code: This will point to a CodeableConcept representing the specific program (e.g. SNAP, WIC, etc.).
  • Observation.subject: This will reference the Patient resource for the individual.
  • Observation.effective[x]: This will capture the date and time information relevant to the status.
  • Observation.value[x]: This CodeableConcept will contain the specific status, with potential values including:
    • Enrolled
    • Not enrolled
    • Not enrolled, on waitlist
  • Observation.note: Used to capture additional information about the enrollment status such as information about the waitlist (e.g. “The waitlist is currently 2 months long. We will notify the individual when they are ready to be enrolled.”).

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(8.0.1) assessment observation
Constraints: obs-6, obs-7
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element 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 value:$this
Binding: USCoreSimpleObservationCategory (8.0.1) (preferred): FHIR and US Core 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 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
Additional BindingsPurpose
USCoreScreeningAssessmentObservationCategory (8.0.1) Min Binding

Observation.Slices for category.category:enrollment 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "program-enrollment"
    }
  ]
}
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: Social Determinants of Health Programs SNOMED CT (preferred)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(8.0.1) This type must be supported. | Group | Device | US Core Location Profile(8.0.1)) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(SDOHCC Healthcare Service) What the observation is about, when it is not about the subject of record
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 Practitioner Profile(8.0.1) This type must be supported. | US Core Patient Profile(8.0.1) This type must be supported. | US Core Organization Profile(8.0.1) | PractitionerRole | US Core CareTeam Profile(8.0.1) | US Core RelatedPerson Profile(8.0.1)) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 1..1 Actual result
Binding: SDOHCC ValueSet Program Enrollment Status (preferred): Codes for enrollment status
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

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 US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:us-core Base required US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:enrollment Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
Observation.value[x] Base preferred SDOHCC ValueSet Program Enrollment Status 📦3.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* USCoreSimpleObservationProfile(8.0.1) assessment observation
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:enrollment 0..1 CodeableConcept Classification of type of observation
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "program-enrollment"
    }
  ]
}
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: Social Determinants of Health Programs SNOMED CT (preferred)
Observation.focus 0..* Reference(SDOHCC Healthcare Service) What the observation is about, when it is not about the subject of record
Observation.value[x] 1..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
Binding: SDOHCC ValueSet Program Enrollment Status (preferred): Codes for enrollment status

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 Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
Observation.value[x] Base preferred SDOHCC ValueSet Program Enrollment Status 📦3.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USCoreSimpleObservationProfile(8.0.1) assessment observation
Constraints: obs-6, obs-7
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element 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 value:$this
Binding: USCoreSimpleObservationCategory (8.0.1) (preferred): FHIR and US Core 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 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
Additional BindingsPurpose
USCoreScreeningAssessmentObservationCategory (8.0.1) Min Binding

Observation.Slices for category.category:enrollment 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "program-enrollment"
    }
  ]
}
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: Social Determinants of Health Programs SNOMED CT (preferred)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(8.0.1) This type must be supported. | Group | Device | US Core Location Profile(8.0.1)) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(SDOHCC Healthcare Service) 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 Practitioner Profile(8.0.1) This type must be supported. | US Core Patient Profile(8.0.1) This type must be supported. | US Core Organization Profile(8.0.1) | PractitionerRole | US Core CareTeam Profile(8.0.1) | US Core RelatedPerson Profile(8.0.1)) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 1..1 Actual result
Binding: SDOHCC ValueSet Program Enrollment Status (preferred): Codes for enrollment status
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(4.0.1) Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(Observation | US Core DocumentReference Profile(8.0.1) | US Core QuestionnaireResponse Profile(8.0.1) | ImagingStudy | Media | MolecularSequence) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:us-core Base required US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:enrollment Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
Observation.value[x] Base preferred SDOHCC ValueSet Program Enrollment Status 📦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
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from USCoreSimpleObservationProfile

Summary

Mandatory: 2 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USCoreSimpleObservationProfile(8.0.1) assessment observation
Constraints: obs-6, obs-7
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element 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 value:$this
Binding: USCoreSimpleObservationCategory (8.0.1) (preferred): FHIR and US Core 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 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
Additional BindingsPurpose
USCoreScreeningAssessmentObservationCategory (8.0.1) Min Binding

Observation.Slices for category.category:enrollment 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "program-enrollment"
    }
  ]
}
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: Social Determinants of Health Programs SNOMED CT (preferred)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(8.0.1) This type must be supported. | Group | Device | US Core Location Profile(8.0.1)) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(SDOHCC Healthcare Service) What the observation is about, when it is not about the subject of record
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 Practitioner Profile(8.0.1) This type must be supported. | US Core Patient Profile(8.0.1) This type must be supported. | US Core Organization Profile(8.0.1) | PractitionerRole | US Core CareTeam Profile(8.0.1) | US Core RelatedPerson Profile(8.0.1)) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 1..1 Actual result
Binding: SDOHCC ValueSet Program Enrollment Status (preferred): Codes for enrollment status
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

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 US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:us-core Base required US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:enrollment Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
Observation.value[x] Base preferred SDOHCC ValueSet Program Enrollment Status 📦3.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* USCoreSimpleObservationProfile(8.0.1) assessment observation
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:enrollment 0..1 CodeableConcept Classification of type of observation
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "program-enrollment"
    }
  ]
}
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: Social Determinants of Health Programs SNOMED CT (preferred)
Observation.focus 0..* Reference(SDOHCC Healthcare Service) What the observation is about, when it is not about the subject of record
Observation.effective[x] 0..1 dateTime, Period, Timing, instant Clinically relevant time/time-period for observation
Observation.value[x] 1..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
Binding: SDOHCC ValueSet Program Enrollment Status (preferred): Codes for enrollment status

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 Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
Observation.value[x] Base preferred SDOHCC ValueSet Program Enrollment Status 📦3.1.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USCoreSimpleObservationProfile(8.0.1) assessment observation
Constraints: obs-6, obs-7
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element 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 value:$this
Binding: USCoreSimpleObservationCategory (8.0.1) (preferred): FHIR and US Core 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 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
Additional BindingsPurpose
USCoreScreeningAssessmentObservationCategory (8.0.1) Min Binding

Observation.Slices for category.category:enrollment 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "program-enrollment"
    }
  ]
}
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: Social Determinants of Health Programs SNOMED CT (preferred)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(8.0.1) This type must be supported. | Group | Device | US Core Location Profile(8.0.1)) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(SDOHCC Healthcare Service) 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 Practitioner Profile(8.0.1) This type must be supported. | US Core Patient Profile(8.0.1) This type must be supported. | US Core Organization Profile(8.0.1) | PractitionerRole | US Core CareTeam Profile(8.0.1) | US Core RelatedPerson Profile(8.0.1)) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 1..1 Actual result
Binding: SDOHCC ValueSet Program Enrollment Status (preferred): Codes for enrollment status
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(4.0.1) Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(Observation | US Core DocumentReference Profile(8.0.1) | US Core QuestionnaireResponse Profile(8.0.1) | ImagingStudy | Media | MolecularSequence) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:us-core Base required US Core Simple Observation Category 📍8.0.1 US Core v8.0
Observation.category:enrollment Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:SDOHCC Base required SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Observation.code Base preferred Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
Observation.value[x] Base preferred SDOHCC ValueSet Program Enrollment Status 📦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
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from USCoreSimpleObservationProfile

Summary

Mandatory: 2 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron