SDOH Clinical Care
2.2.0 - STU 2.2
SDOH Clinical Care
2.2.0 - STU 2.2
SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.2.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
| Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationScreeningResponse | Version: 2.2.0 | |||
| Standards status: Trial-use | Computable Name: SDOHCCObservationScreeningResponse | |||
Profile for observations that represent question and answer pairs from Social Determinants of Health (SDOH) screening instruments.
SDOHCC Observation Screening Response (OSR) is intended to represent question-answer pairs from Social Determinants of Health (SDOH) assessment instruments. An OSR that identifies a social risk or need can be referenced as evidence for an SDOHCC Condition. Additionally, an OSR may be addressed by, or be the outcome of, an SDOHCC Goal, or the reason for an SDOHCC ServiceRequest or SDOHCC Procedure. See the Data Modeling Framework for more detail on the relationships between OSR and other profiles in this IG.
This IG focuses on a workflow where completed assessment instruments are captured using QuestionnaireResponse. To facilitate querying and searching, individual question-answer pairs from a QuestionnaireResponse can be converted into Observations. The decision as to which responses from a QuestionnaireResponse to convert into Observations will generally be driven by the usage need. For more information on this topic see Representing Assessment Instrument Data in a FHIR Format.
In the future, for standardized assessment instruments, a StructureMap instance would ideally be provided by a Questionnaire steward to ensure consistency in the Observations and Conditions (i.e., unconfirmed health concerns) generated from the assessment instrument. For more information on this topic, see Using StructureMap to Generate Observations or Conditions from QuestionnaireResponse.
Observation.code and Observation.value have bindings to LOINCCodes (required). Observation.code and Observation.value also have additional bindings to SDOH domain-specific value sets (e.g., for Food Insecurity, Inadequate Housing, etc.) which are determined by the value selected for Observation.category. When Observataion.category is a value from SDOHCC ValueSet SDOH Category (e.g., food-insecurity), Observation.code and Observation.value SHALL be selected from the corresponding domain-specific value set found in Additional Bindings (e.g. Food Insecurity Screening Assessments And Questions for Observation.code and Food Insecurity Screening Assessments Answers for Observation.value). If more than one value is selected from SDOHCC ValueSet SDOH Category (e.g., food-insecurity and financial-insecurity) for Observation.category, then Observation.code and Observation.value SHALL be selected from at least one of the corresponding domain-specific value sets found in Additional Bindings (e.g. Food Insecurity Screening Assessments And Questions for Observation.code and Food Insecurity Screening Assessments Answers for Observation.value).
Occasionally, questions are reused across assessment instruments and represented by the same LOINC code, but the question’s allowed answer set may vary on different assessment instruments. Therefore, the allowed answer set (for Observation.value) for a question (Observation.code) is determined by the assessment instrument. For this reason, Gravity provides Downloadable Assessment Instrument Spreadsheets that link Gravity-vetted questions to the assessment instruments from which they were chosen and their allowed answer sets. For access to the Spreadsheets and more information on this topic, see Social Risk Terminology Value Sets on the Gravity Confluence site and specifically the Assessment Instruments Spreadsheet Guidance document.
Of note, Gravity Project is continuously developing terminology for new SDOH domains. For new SDOH domains where the Gravity terminology development cycle is in progress, domain-specific value sets may not yet be available in VSAC. If a domain-specific value set is not yet available in VSAC, the Additional Binding is the default binding for the profile element. If a domain-specific value set is available in VSAC but does not yet include all standardized codes identified during the domain’s terminology development cycle, the value set’s VSAC “Description” tab will state, “In progress”. Additional information related to Gravity value sets is provided on the Social Risk Terminology Value Sets page on the Gravity Project Confluence site.
Additionally, some SDOH domains may not yet be represented in SDOHCC ValueSet SDOH Category. In this case, Observation.category: sdoh-category-unspecified can be used so that the Observation instance can still be categorized as SDOH-related. If desired, category.text can also be used to further specify the domain. For example, at the time of publication of this IG, “disability-status” is not yet included in SDOHCC ValueSet SDOH Category. In this case, Observation.category: sdoh-category-unspecified can be used along with category.text: Disability Status. For Observation.category: sdoh-category-unspecified, there will not be domain-specific value sets and Additional Bindings for Observation.code and Observation.value will designate the default binding to LOINCCodes (required).
For more information on the correlation between Observation.category and the domain-specific value sets in Additional Bindings for Observation.code and Observation.value, see Gravity Project Value Sets.
When Observation.category is used to tag Observations by SDOH domain (e.g., Food Insecurity, Housing Instability), Observation.interpretation: POS (Positive) can be used to flag Observations that might represent a health-related social need (HRSN) in the specified SDOH domain(s). For more information on the use of Observation.category and Observation.interpretation and their interplay when used with OSR, see Additional Guidance on SDOHCC Observation Screening Response Elements.
Observation can also indicate relationships to other artifacts. For example:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
0..* | Observation | SDOH screening questionnaire observations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  status |
S | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  Slices for category |
2..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
   category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
   coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:Survey |
S | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 category:SDOH |
S | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 subject |
S | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 effective[x] |
S | 1..1 | Clinically relevant time/time-period for observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 effectiveDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 effectivePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| performer |
S | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for value[x] |
S | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result Slice: Unordered, Open by type:$this | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 value[x]:valueQuantity |
0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataAbsentReason |
S | 0..1 | CodeableConcept | Why the result is missing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| bodySite |
0..0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| specimen |
0..0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for hasMember |
0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| hasMember:SupportedHasMember |
S | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 Slices for derivedFrom |
S | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| derivedFrom:SupportedDerivedFrom |
S | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Path | Conformance | ValueSet | URI | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatusfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategoryfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.code | required | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | SDOH screening questionnaire observations obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status |
?!SΣ | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for category |
2..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:Survey |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SDOH |
S | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effective[x] |
SΣ | 1..1 | Clinically relevant time/time-period for observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| performer |
SΣ | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for value[x] |
SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueQuantity |
ΣC | 0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueCodeableConcept |
ΣC | 0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataAbsentReason |
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| hasMember:SupportedHasMember |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for derivedFrom |
SΣ | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| derivedFrom:SupportedDerivedFrom |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatusfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SocialHistory | preferred | Pattern: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:Survey | preferred | Pattern: surveyhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategoryfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.code | required | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | SDOH screening questionnaire observations obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status |
?!SΣ | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for category |
2..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 text |
0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:Survey |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SDOH |
S | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effective[x] |
SΣ | 1..1 | Clinically relevant time/time-period for observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| performer |
SΣ | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for value[x] |
SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueQuantity |
ΣC | 0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueCodeableConcept |
ΣC | 0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataAbsentReason |
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| note |
0..* | Annotation | Comments about the observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| low |
C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| high |
C | 0..1 | SimpleQuantity | High Range, if relevant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| text |
0..1 | string | Text based reference range in an observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| hasMember:SupportedHasMember |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for derivedFrom |
SΣ | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| derivedFrom:SupportedDerivedFrom |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x] |
Σ | 0..1 | Actual component result | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatusfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SocialHistory | preferred | Pattern: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:Survey | preferred | Pattern: surveyhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategoryfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.code | required | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-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() |
This structure is derived from Observation
Summary
Mandatory: 4 elements
Must-Support: 13 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
0..* | Observation | SDOH screening questionnaire observations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status |
S | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for category |
2..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:Survey |
S | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SDOH |
S | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subject |
S | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effective[x] |
S | 1..1 | Clinically relevant time/time-period for observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| performer |
S | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for value[x] |
S | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result Slice: Unordered, Open by type:$this | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueQuantity |
0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataAbsentReason |
S | 0..1 | CodeableConcept | Why the result is missing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| bodySite |
0..0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| specimen |
0..0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for hasMember |
0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| hasMember:SupportedHasMember |
S | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for derivedFrom |
S | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| derivedFrom:SupportedDerivedFrom |
S | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Path | Conformance | ValueSet | URI | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatusfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategoryfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.code | required | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | SDOH screening questionnaire observations obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status |
?!SΣ | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for category |
2..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:Survey |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SDOH |
S | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effective[x] |
SΣ | 1..1 | Clinically relevant time/time-period for observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| performer |
SΣ | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for value[x] |
SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueQuantity |
ΣC | 0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueCodeableConcept |
ΣC | 0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataAbsentReason |
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| hasMember:SupportedHasMember |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for derivedFrom |
SΣ | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| derivedFrom:SupportedDerivedFrom |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatusfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SocialHistory | preferred | Pattern: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:Survey | preferred | Pattern: surveyhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategoryfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.code | required | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | SDOH screening questionnaire observations obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status |
?!SΣ | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for category |
2..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SocialHistory |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:Survey |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| category:SDOH |
S | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effective[x] |
SΣ | 1..1 | Clinically relevant time/time-period for observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectivePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| performer |
SΣ | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for value[x] |
SΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueQuantity |
ΣC | 0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x]:valueCodeableConcept |
ΣC | 0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataAbsentReason |
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| note |
0..* | Annotation | Comments about the observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| low |
C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| high |
C | 0..1 | SimpleQuantity | High Range, if relevant | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| text |
0..1 | string | Text based reference range in an observation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| hasMember:SupportedHasMember |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Slices for derivedFrom |
SΣ | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| derivedFrom:SupportedDerivedFrom |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value[x] |
Σ | 0..1 | Actual component result | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatusfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SocialHistory | preferred | Pattern: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:Survey | preferred | Pattern: surveyhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategoryfrom this IG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.code | required | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-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() |
This structure is derived from Observation
Summary
Mandatory: 4 elements
Must-Support: 13 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Patient Care. Package hl7.fhir.us.sdoh-clinicalcare#2.2.0 based on FHIR 4.0.1. Generated 2024-09-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
