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 Personal Pronouns

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

Profile for observations about the pronouns and possessive adjectives a person wishes to be addressed by. For further details on this profile see Specifications for Personal Characteristics.

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..* SDOHCCObservationPersonalCharacteristic Personal characteristic observation
Constraints: obs-6, obs-7, SDOH-Obs-2, SDOH-Obs-3
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 final | corrected | entered-in-error | unknown
Binding: SDOHCC ValueSet Observation Status (required)
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. 0..* CodeableConcept Classification of type of observation
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:PersonalCharacteristic This element must be supported. 1..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" : "personal-characteristic"
    }
  ]
}
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (preferred): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "90778-2"
    }
  ]
}
Observation.subject This element must be supported. This element is included in summaries. C 1..1 Reference(US Core Patient Profile(7.0.0)) Who and/or what the observation is about
Constraints: SDOH-Obs-1
Observation.subject.Slices for extension Content/Rules for all slices
Observation.subject.Slices for extension.extension:subjectPractitioner This element must be supported. 0..1 (Complex) Alternate subject reference to a Practitioner
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Observation.subject.Slices for extension.extension:subjectPractitioner.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.subject.Slices for extension.extension:subjectPractitioner.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
Observation.subject.Slices for extension.extension:subjectPractitioner.value[x] 1..1 Reference(US Core Practitioner Profile(7.0.0)) Value of extension
Observation.focus This element is included in summaries. C 0..1 Reference(RelatedPerson) 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.performer This element must be supported. This element is included in summaries. C 0..* Reference(US Core Practitioner Profile(8.0.1) | US Core Organization Profile(8.0.1) | US Core Patient 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 CodeableConcept This type must be supported. Actual result
Binding: SDOHCC ValueSet Pronouns Value (preferred): Codes for personal pronouns
Observation.value[x].Slices for extension Content/Rules for all slices
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.value[x] This element must be supported. 1..1 code Value of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
Fixed Value: masked (no extensions allowed)
Observation.value[x].coding This element must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Observation.method This element must be supported. 1..1 CodeableConcept How it was done
Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations.
Observation.derivedFrom This element must be supported. This element is included in summaries. C 0..* Reference(US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | Observation) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 SDOHCC ValueSet Observation Status 📦3.1.0 This IG
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:PersonalCharacteristic Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base preferred LOINC Codes 📦4.0.1 FHIR Std.
Observation.value[x] Base preferred SDOHCC ValueSet Pronouns Value 📦3.1.0 This IG
Observation.value[x].​extension:DataAbsentReasonMasked.​value[x] Base required DataAbsentReason 📍4.0.1 FHIR Std.
Observation.method Base extensible SDOHCC ValueSet Observation Method 📦3.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
SDOH-Obs-1 error Observation.subject Either subject or extension-Observation.subject must exist but not both reference.exists() xor extension('http://hl7.org/fhir/StructureDefinition/alternate-reference').exists()
SDOH-Obs-2 error Observation Focus is only allowed if subject is present focus.exists() implies subject.exists()
SDOH-Obs-3 error Observation Must have either performer or derivedFrom performer.exists() or derivedFrom.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()

This structure is derived from SDOHCCObservationPersonalCharacteristic

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* SDOHCCObservationPersonalCharacteristic Personal characteristic observation
Observation.code 1..1 CodeableConcept Type of observation (code / type)
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "90778-2"
    }
  ]
}
Observation.value[x] 1..1 CodeableConcept Actual result
Binding: SDOHCC ValueSet Pronouns Value (preferred): Codes for personal pronouns
Observation.value[x].Slices for extension Content/Rules for all slices
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.value[x] This element must be supported. 1..1 code Value of extension
Fixed Value: masked (no extensions allowed)
Observation.value[x].coding This element must be supported. 0..* Coding Code defined by a terminology system
Observation.dataAbsentReason 0..0 Why the result is missing

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.value[x] Base preferred SDOHCC ValueSet Pronouns Value 📦3.1.0 This IG
Observation.method Base extensible SDOHCC ValueSet Observation Method 📦3.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* SDOHCCObservationPersonalCharacteristic Personal characteristic observation
Constraints: obs-6, obs-7, SDOH-Obs-2, SDOH-Obs-3
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 final | corrected | entered-in-error | unknown
Binding: SDOHCC ValueSet Observation Status (required)
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. 0..* CodeableConcept Classification of type of observation
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:PersonalCharacteristic This element must be supported. 1..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" : "personal-characteristic"
    }
  ]
}
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (preferred): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "90778-2"
    }
  ]
}
Observation.subject This element must be supported. This element is included in summaries. C 1..1 Reference(US Core Patient Profile(7.0.0)) Who and/or what the observation is about
Constraints: SDOH-Obs-1
Observation.subject.id 0..1 string Unique id for inter-element referencing
Observation.subject.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.subject.Slices for extension.extension:subjectPractitioner This element must be supported. 0..1 (Complex) Alternate subject reference to a Practitioner
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Observation.subject.Slices for extension.extension:subjectPractitioner.id 0..1 string Unique id for inter-element referencing
Observation.subject.Slices for extension.extension:subjectPractitioner.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.subject.Slices for extension.extension:subjectPractitioner.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
Observation.subject.Slices for extension.extension:subjectPractitioner.value[x] 1..1 Reference(US Core Practitioner Profile(7.0.0)) Value of extension
Observation.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Observation.subject.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Observation.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Observation.subject.display This element is included in summaries. 0..1 string Text alternative for the resource
Observation.focus This element is included in summaries. C 0..1 Reference(RelatedPerson) 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.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. C 0..* Reference(US Core Practitioner Profile(8.0.1) | US Core Organization Profile(8.0.1) | US Core Patient 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 CodeableConcept This type must be supported. Actual result
Binding: SDOHCC ValueSet Pronouns Value (preferred): Codes for personal pronouns
Observation.value[x].id 0..1 string Unique id for inter-element referencing
Observation.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.id 0..1 string Unique id for inter-element referencing
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.value[x] This element must be supported. 1..1 code Value of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
Fixed Value: masked (no extensions allowed)
Observation.value[x].coding This element must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Observation.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
Observation.note 0..* Annotation Comments about the observation
Observation.method This element must be supported. 1..1 CodeableConcept How it was done
Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations.
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
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 must be supported. This element is included in summaries. C 0..* Reference(US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | Observation) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 SDOHCC ValueSet Observation Status 📦3.1.0 This IG
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:PersonalCharacteristic Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base preferred LOINC Codes 📦4.0.1 FHIR Std.
Observation.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.value[x] Base preferred SDOHCC ValueSet Pronouns Value 📦3.1.0 This IG
Observation.value[x].​extension:DataAbsentReasonMasked.​value[x] Base required DataAbsentReason 📍4.0.1 FHIR Std.
Observation.method Base extensible SDOHCC ValueSet Observation Method 📦3.1.0 This IG
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-1 error Observation.subject Either subject or extension-Observation.subject must exist but not both reference.exists() xor extension('http://hl7.org/fhir/StructureDefinition/alternate-reference').exists()
SDOH-Obs-2 error Observation Focus is only allowed if subject is present focus.exists() implies subject.exists()
SDOH-Obs-3 error Observation Must have either performer or derivedFrom performer.exists() or derivedFrom.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()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from SDOHCCObservationPersonalCharacteristic

Summary

Mandatory: 2 elements
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* SDOHCCObservationPersonalCharacteristic Personal characteristic observation
Constraints: obs-6, obs-7, SDOH-Obs-2, SDOH-Obs-3
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 final | corrected | entered-in-error | unknown
Binding: SDOHCC ValueSet Observation Status (required)
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. 0..* CodeableConcept Classification of type of observation
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:PersonalCharacteristic This element must be supported. 1..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" : "personal-characteristic"
    }
  ]
}
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (preferred): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "90778-2"
    }
  ]
}
Observation.subject This element must be supported. This element is included in summaries. C 1..1 Reference(US Core Patient Profile(7.0.0)) Who and/or what the observation is about
Constraints: SDOH-Obs-1
Observation.subject.Slices for extension Content/Rules for all slices
Observation.subject.Slices for extension.extension:subjectPractitioner This element must be supported. 0..1 (Complex) Alternate subject reference to a Practitioner
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Observation.subject.Slices for extension.extension:subjectPractitioner.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.subject.Slices for extension.extension:subjectPractitioner.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
Observation.subject.Slices for extension.extension:subjectPractitioner.value[x] 1..1 Reference(US Core Practitioner Profile(7.0.0)) Value of extension
Observation.focus This element is included in summaries. C 0..1 Reference(RelatedPerson) 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.performer This element must be supported. This element is included in summaries. C 0..* Reference(US Core Practitioner Profile(8.0.1) | US Core Organization Profile(8.0.1) | US Core Patient 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 CodeableConcept This type must be supported. Actual result
Binding: SDOHCC ValueSet Pronouns Value (preferred): Codes for personal pronouns
Observation.value[x].Slices for extension Content/Rules for all slices
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.value[x] This element must be supported. 1..1 code Value of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
Fixed Value: masked (no extensions allowed)
Observation.value[x].coding This element must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Observation.method This element must be supported. 1..1 CodeableConcept How it was done
Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations.
Observation.derivedFrom This element must be supported. This element is included in summaries. C 0..* Reference(US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | Observation) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 SDOHCC ValueSet Observation Status 📦3.1.0 This IG
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:PersonalCharacteristic Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base preferred LOINC Codes 📦4.0.1 FHIR Std.
Observation.value[x] Base preferred SDOHCC ValueSet Pronouns Value 📦3.1.0 This IG
Observation.value[x].​extension:DataAbsentReasonMasked.​value[x] Base required DataAbsentReason 📍4.0.1 FHIR Std.
Observation.method Base extensible SDOHCC ValueSet Observation Method 📦3.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
SDOH-Obs-1 error Observation.subject Either subject or extension-Observation.subject must exist but not both reference.exists() xor extension('http://hl7.org/fhir/StructureDefinition/alternate-reference').exists()
SDOH-Obs-2 error Observation Focus is only allowed if subject is present focus.exists() implies subject.exists()
SDOH-Obs-3 error Observation Must have either performer or derivedFrom performer.exists() or derivedFrom.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()

Differential View

This structure is derived from SDOHCCObservationPersonalCharacteristic

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* SDOHCCObservationPersonalCharacteristic Personal characteristic observation
Observation.code 1..1 CodeableConcept Type of observation (code / type)
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "90778-2"
    }
  ]
}
Observation.value[x] 1..1 CodeableConcept Actual result
Binding: SDOHCC ValueSet Pronouns Value (preferred): Codes for personal pronouns
Observation.value[x].Slices for extension Content/Rules for all slices
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.value[x] This element must be supported. 1..1 code Value of extension
Fixed Value: masked (no extensions allowed)
Observation.value[x].coding This element must be supported. 0..* Coding Code defined by a terminology system
Observation.dataAbsentReason 0..0 Why the result is missing
Observation.method This element must be supported. 1..1 CodeableConcept How it was done
Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.value[x] Base preferred SDOHCC ValueSet Pronouns Value 📦3.1.0 This IG
Observation.method Base extensible SDOHCC ValueSet Observation Method 📦3.1.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* SDOHCCObservationPersonalCharacteristic Personal characteristic observation
Constraints: obs-6, obs-7, SDOH-Obs-2, SDOH-Obs-3
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 final | corrected | entered-in-error | unknown
Binding: SDOHCC ValueSet Observation Status (required)
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. 0..* CodeableConcept Classification of type of observation
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:PersonalCharacteristic This element must be supported. 1..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" : "personal-characteristic"
    }
  ]
}
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (preferred): Codes identifying names of simple observations.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "90778-2"
    }
  ]
}
Observation.subject This element must be supported. This element is included in summaries. C 1..1 Reference(US Core Patient Profile(7.0.0)) Who and/or what the observation is about
Constraints: SDOH-Obs-1
Observation.subject.id 0..1 string Unique id for inter-element referencing
Observation.subject.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.subject.Slices for extension.extension:subjectPractitioner This element must be supported. 0..1 (Complex) Alternate subject reference to a Practitioner
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Observation.subject.Slices for extension.extension:subjectPractitioner.id 0..1 string Unique id for inter-element referencing
Observation.subject.Slices for extension.extension:subjectPractitioner.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.subject.Slices for extension.extension:subjectPractitioner.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
Observation.subject.Slices for extension.extension:subjectPractitioner.value[x] 1..1 Reference(US Core Practitioner Profile(7.0.0)) Value of extension
Observation.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Observation.subject.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Observation.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Observation.subject.display This element is included in summaries. 0..1 string Text alternative for the resource
Observation.focus This element is included in summaries. C 0..1 Reference(RelatedPerson) 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.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. C 0..* Reference(US Core Practitioner Profile(8.0.1) | US Core Organization Profile(8.0.1) | US Core Patient 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 CodeableConcept This type must be supported. Actual result
Binding: SDOHCC ValueSet Pronouns Value (preferred): Codes for personal pronouns
Observation.value[x].id 0..1 string Unique id for inter-element referencing
Observation.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.id 0..1 string Unique id for inter-element referencing
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
Observation.value[x].Slices for extension.extension:DataAbsentReasonMasked.value[x] This element must be supported. 1..1 code Value of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
Fixed Value: masked (no extensions allowed)
Observation.value[x].coding This element must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Observation.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
Observation.note 0..* Annotation Comments about the observation
Observation.method This element must be supported. 1..1 CodeableConcept How it was done
Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations.
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
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 must be supported. This element is included in summaries. C 0..* Reference(US Core DocumentReference Profile(7.0.0) | US Core QuestionnaireResponse Profile(7.0.0) | Observation) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 SDOHCC ValueSet Observation Status 📦3.1.0 This IG
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:PersonalCharacteristic Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base preferred LOINC Codes 📦4.0.1 FHIR Std.
Observation.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.value[x] Base preferred SDOHCC ValueSet Pronouns Value 📦3.1.0 This IG
Observation.value[x].​extension:DataAbsentReasonMasked.​value[x] Base required DataAbsentReason 📍4.0.1 FHIR Std.
Observation.method Base extensible SDOHCC ValueSet Observation Method 📦3.1.0 This IG
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-1 error Observation.subject Either subject or extension-Observation.subject must exist but not both reference.exists() xor extension('http://hl7.org/fhir/StructureDefinition/alternate-reference').exists()
SDOH-Obs-2 error Observation Focus is only allowed if subject is present focus.exists() implies subject.exists()
SDOH-Obs-3 error Observation Must have either performer or derivedFrom performer.exists() or derivedFrom.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()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from SDOHCCObservationPersonalCharacteristic

Summary

Mandatory: 2 elements
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron