SDOH Clinical Care
2.1.0 - STU 2.1
SDOH Clinical Care
2.1.0 - STU 2.1
SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.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
| Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB | Version: 2.1.0 | |||
| Standards status: Trial-use | Computable Name: SDOHCCObservationRaceOMB | |||
Profile for race observations that use Office of Management and Budget (OMB) race category codes and CDC race codes. This profile is intended for draft use only. For further details on this profile see Draft Specifications for Personal Characteristics.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SDOHCCObservationPersonalCharacteristic
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | C | 0..* | SDOHCCObservationPersonalCharacteristic | Race observation SDOH-Race-1: Must have either a dataAbsentReason or at least one of the defined race components but not both |
  code | 1..1 | CodeableConcept | Type of observation (code / type) 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://loinc.org | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | 0..0 | |||
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: SDOHCC ValueSet Observation DataAbsentReason (required) |
| method | S | 1..1 | CodeableConcept | How it was done Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations. |
 Slices for component | C | 0..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code, type:value, value:value |
  component:RaceDescription | S | 0..1 | BackboneElement | Component results |
  code | S | 1..1 | CodeableConcept | Type of component observation (code / type) 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
  value[x] | S | 1..1 | string | Actual component result |
| dataAbsentReason | 0..0 | |||
| interpretation | 0..0 | |||
 referenceRange | 0..0 | |||
| component:Race | S | 0..5 | BackboneElement | Component results |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
 value[x] | S | 1..1 | CodeableConcept | Race category codes Binding: Race Category Excluding Nulls  (required): Codes for the five OMB race categories |
| dataAbsentReason | 0..0 | |||
| interpretation | 0..0 | |||
| referenceRange | 0..0 | |||
 component:DetailedRace | 0..* | BackboneElement | Component results | |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | S | 1..1 | CodeableConcept | Detailed race codes Binding: Detailed Race (required): CDC race codes that further specify the 5 OMB race category codes |
| dataAbsentReason | 0..0 | |||
| interpretation | 0..0 | |||
| referenceRange | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReasonhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationDataAbsentReasonfrom this IG | |
| Observation.method | extensible | SDOHCCValueSetObservationMethodhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationMethodfrom this IG | |
| Observation.component:Race.value[x] | required | Race Category Excluding Nulls http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3 | |
| Observation.component:DetailedRace.value[x] | required | DetailedRacehttp://hl7.org/fhir/us/core/ValueSet/detailed-race |
| Id | Grade | Path(s) | Details | Requirements |
| SDOH-Race-1 | error | Observation | Must have either a dataAbsentReason or at least one of the defined race components but not both : dataAbsentReason.exists() xor component.where(code.coding.exists(system='http://loinc.org' and code='72826-1')).exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | SDOHCCObservationPersonalCharacteristic | Race observation 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 SDOH-Obs-1: Either subject or extension-Observation.subject must exist but not both SDOH-Obs-2: Focus is only allowed if subject is present SDOH-Obs-3: Must have either performer or derivedFrom SDOH-Race-1: Must have either a dataAbsentReason or at least one of the defined race components but not both |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| OtherSubject | SC | 0..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject |
 extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject" | |
 value[x] | 1..1 | Reference(US Core Practitioner Profile) | Value of extension | |
 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 | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| category:PersonalCharacteristic | 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://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: personal-characteristic | |
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (preferred): Codes identifying names of simple observations. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| subject | SΣC | 0..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about |
| focus | ΣC | 0..1 | Reference(RelatedPerson) | What the observation is about, when it is not about the subject of record |
| performer | SΣC | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: SDOHCC ValueSet Observation DataAbsentReason (required) |
| method | S | 1..1 | CodeableConcept | How it was done Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations. |
| derivedFrom | SΣC | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from |
| Slices for component | ΣC | 0..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code, type:value, value:value |
| component:All Slices | Content/Rules for all slices | |||
 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. |
| component:RaceDescription | SΣ | 0..1 | BackboneElement | Component results |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | SΣ | 1..1 | string | Actual component result |
| component:Race | SΣ | 0..5 | BackboneElement | Component results |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | SΣ | 1..1 | CodeableConcept | Race category codes Binding: Race Category Excluding Nulls (required): Codes for the five OMB race categories |
| component:DetailedRace | Σ | 0..* | BackboneElement | Component results |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | SΣ | 1..1 | CodeableConcept | Detailed race codes Binding: Detailed Race (required): CDC race codes that further specify the 5 OMB race category codes |
| 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:PersonalCharacteristic | preferred | Pattern: personal-characteristichttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | preferred | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReasonhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationDataAbsentReasonfrom this IG | |
| Observation.method | extensible | SDOHCCValueSetObservationMethodhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationMethodfrom this IG | |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:RaceDescription.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:Race.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:Race.value[x] | required | Race Category Excluding Nulls http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3 | |
| Observation.component:DetailedRace.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:DetailedRace.value[x] | required | DetailedRacehttp://hl7.org/fhir/us/core/ValueSet/detailed-race |
| Id | Grade | Path(s) | Details | Requirements |
| SDOH-Obs-1 | error | Observation | Either subject or extension-Observation.subject must exist but not both : subject.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject').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() | |
| SDOH-Race-1 | error | Observation | Must have either a dataAbsentReason or at least one of the defined race components but not both : dataAbsentReason.exists() xor component.where(code.coding.exists(system='http://loinc.org' and code='72826-1')).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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | SDOHCCObservationPersonalCharacteristic | Race observation 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 SDOH-Obs-1: Either subject or extension-Observation.subject must exist but not both SDOH-Obs-2: Focus is only allowed if subject is present SDOH-Obs-3: Must have either performer or derivedFrom SDOH-Race-1: Must have either a dataAbsentReason or at least one of the defined race components but not both | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| OtherSubject | SC | 0..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject" | |||||
| value[x] | 1..1 | Reference(US Core Practitioner Profile) | Value of extension | |||||
| 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 | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| category:PersonalCharacteristic | 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://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: personal-characteristic | |||||
| 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 | |||||
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (preferred): Codes identifying names of simple observations. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |||||
| 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 | |||||
| subject | SΣC | 0..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | ||||
| focus | ΣC | 0..1 | Reference(RelatedPerson) | 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] | Σ | 0..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ΣC | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: SDOHCC ValueSet Observation DataAbsentReason (required) | ||||
| note | 0..* | Annotation | Comments about the observation | |||||
| method | S | 1..1 | CodeableConcept | How it was done Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations. | ||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | SΣC | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from | ||||
| Slices for component | ΣC | 0..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code, type:value, value:value | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| 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 | |||||
| component:RaceDescription | SΣ | 0..1 | 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 | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |||||
| 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 | |||||
| value[x] | SΣ | 1..1 | string | Actual component result | ||||
| component:Race | SΣ | 0..5 | 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 | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |||||
| 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 | |||||
| value[x] | SΣ | 1..1 | CodeableConcept | Race category codes Binding: Race Category Excluding Nulls (required): Codes for the five OMB race categories | ||||
| component:DetailedRace | Σ | 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 | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |||||
| 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 | |||||
| value[x] | SΣ | 1..1 | CodeableConcept | Detailed race codes Binding: Detailed Race (required): CDC race codes that further specify the 5 OMB race category codes | ||||
| 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:PersonalCharacteristic | preferred | Pattern: personal-characteristichttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | preferred | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReasonhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationDataAbsentReasonfrom this IG | ||||
| Observation.method | extensible | SDOHCCValueSetObservationMethodhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationMethodfrom this IG | ||||
| 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 | ||||
| Observation.component:RaceDescription.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:Race.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:Race.value[x] | required | Race Category Excluding Nulls http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3 | ||||
| Observation.component:DetailedRace.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:DetailedRace.value[x] | required | DetailedRacehttp://hl7.org/fhir/us/core/ValueSet/detailed-race |
| Id | Grade | Path(s) | Details | Requirements |
| SDOH-Obs-1 | error | Observation | Either subject or extension-Observation.subject must exist but not both : subject.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject').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() | |
| SDOH-Race-1 | error | Observation | Must have either a dataAbsentReason or at least one of the defined race components but not both : dataAbsentReason.exists() xor component.where(code.coding.exists(system='http://loinc.org' and code='72826-1')).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
Summary
Mandatory: 1 element (3 nested mandatory elements)
Must-Support: 10 elements
Prohibited: 10 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from SDOHCCObservationPersonalCharacteristic
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | SDOHCCObservationPersonalCharacteristic | Race observation SDOH-Race-1: Must have either a dataAbsentReason or at least one of the defined race components but not both |
| code | 1..1 | CodeableConcept | Type of observation (code / type) 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | 0..0 | |||
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: SDOHCC ValueSet Observation DataAbsentReason (required) |
| method | S | 1..1 | CodeableConcept | How it was done Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations. |
| Slices for component | C | 0..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code, type:value, value:value |
| component:RaceDescription | S | 0..1 | BackboneElement | Component results |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | S | 1..1 | string | Actual component result |
| dataAbsentReason | 0..0 | |||
| interpretation | 0..0 | |||
| referenceRange | 0..0 | |||
| component:Race | S | 0..5 | BackboneElement | Component results |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | S | 1..1 | CodeableConcept | Race category codes Binding: Race Category Excluding Nulls (required): Codes for the five OMB race categories |
| dataAbsentReason | 0..0 | |||
| interpretation | 0..0 | |||
| referenceRange | 0..0 | |||
| component:DetailedRace | 0..* | BackboneElement | Component results | |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | S | 1..1 | CodeableConcept | Detailed race codes Binding: Detailed Race (required): CDC race codes that further specify the 5 OMB race category codes |
| dataAbsentReason | 0..0 | |||
| interpretation | 0..0 | |||
| referenceRange | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReasonhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationDataAbsentReasonfrom this IG | |
| Observation.method | extensible | SDOHCCValueSetObservationMethodhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationMethodfrom this IG | |
| Observation.component:Race.value[x] | required | Race Category Excluding Nulls http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3 | |
| Observation.component:DetailedRace.value[x] | required | DetailedRacehttp://hl7.org/fhir/us/core/ValueSet/detailed-race |
| Id | Grade | Path(s) | Details | Requirements |
| SDOH-Race-1 | error | Observation | Must have either a dataAbsentReason or at least one of the defined race components but not both : dataAbsentReason.exists() xor component.where(code.coding.exists(system='http://loinc.org' and code='72826-1')).exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | SDOHCCObservationPersonalCharacteristic | Race observation 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 SDOH-Obs-1: Either subject or extension-Observation.subject must exist but not both SDOH-Obs-2: Focus is only allowed if subject is present SDOH-Obs-3: Must have either performer or derivedFrom SDOH-Race-1: Must have either a dataAbsentReason or at least one of the defined race components but not both |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| OtherSubject | SC | 0..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject" | |
| value[x] | 1..1 | Reference(US Core Practitioner Profile) | Value of extension | |
| 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 | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| category:PersonalCharacteristic | 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://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: personal-characteristic | |
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (preferred): Codes identifying names of simple observations. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| subject | SΣC | 0..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about |
| focus | ΣC | 0..1 | Reference(RelatedPerson) | What the observation is about, when it is not about the subject of record |
| performer | SΣC | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: SDOHCC ValueSet Observation DataAbsentReason (required) |
| method | S | 1..1 | CodeableConcept | How it was done Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations. |
| derivedFrom | SΣC | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from |
| Slices for component | ΣC | 0..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code, type:value, value:value |
| component:All Slices | Content/Rules for all slices | |||
| 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. |
| component:RaceDescription | SΣ | 0..1 | BackboneElement | Component results |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | SΣ | 1..1 | string | Actual component result |
| component:Race | SΣ | 0..5 | BackboneElement | Component results |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | SΣ | 1..1 | CodeableConcept | Race category codes Binding: Race Category Excluding Nulls (required): Codes for the five OMB race categories |
| component:DetailedRace | Σ | 0..* | BackboneElement | Component results |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |
| value[x] | SΣ | 1..1 | CodeableConcept | Detailed race codes Binding: Detailed Race (required): CDC race codes that further specify the 5 OMB race category codes |
| 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:PersonalCharacteristic | preferred | Pattern: personal-characteristichttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | preferred | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReasonhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationDataAbsentReasonfrom this IG | |
| Observation.method | extensible | SDOHCCValueSetObservationMethodhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationMethodfrom this IG | |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:RaceDescription.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:Race.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:Race.value[x] | required | Race Category Excluding Nulls http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3 | |
| Observation.component:DetailedRace.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:DetailedRace.value[x] | required | DetailedRacehttp://hl7.org/fhir/us/core/ValueSet/detailed-race |
| Id | Grade | Path(s) | Details | Requirements |
| SDOH-Obs-1 | error | Observation | Either subject or extension-Observation.subject must exist but not both : subject.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject').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() | |
| SDOH-Race-1 | error | Observation | Must have either a dataAbsentReason or at least one of the defined race components but not both : dataAbsentReason.exists() xor component.where(code.coding.exists(system='http://loinc.org' and code='72826-1')).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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | SDOHCCObservationPersonalCharacteristic | Race observation 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 SDOH-Obs-1: Either subject or extension-Observation.subject must exist but not both SDOH-Obs-2: Focus is only allowed if subject is present SDOH-Obs-3: Must have either performer or derivedFrom SDOH-Race-1: Must have either a dataAbsentReason or at least one of the defined race components but not both | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| OtherSubject | SC | 0..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject" | |||||
| value[x] | 1..1 | Reference(US Core Practitioner Profile) | Value of extension | |||||
| 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 | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| category:PersonalCharacteristic | 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://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: personal-characteristic | |||||
| 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 | |||||
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (preferred): Codes identifying names of simple observations. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |||||
| 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 | |||||
| subject | SΣC | 0..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | ||||
| focus | ΣC | 0..1 | Reference(RelatedPerson) | 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] | Σ | 0..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ΣC | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: SDOHCC ValueSet Observation DataAbsentReason (required) | ||||
| note | 0..* | Annotation | Comments about the observation | |||||
| method | S | 1..1 | CodeableConcept | How it was done Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations. | ||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | SΣC | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from | ||||
| Slices for component | ΣC | 0..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code, type:value, value:value | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| 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 | |||||
| component:RaceDescription | SΣ | 0..1 | 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 | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |||||
| 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 | |||||
| value[x] | SΣ | 1..1 | string | Actual component result | ||||
| component:Race | SΣ | 0..5 | 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 | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |||||
| 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 | |||||
| value[x] | SΣ | 1..1 | CodeableConcept | Race category codes Binding: Race Category Excluding Nulls (required): Codes for the five OMB race categories | ||||
| component:DetailedRace | Σ | 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 | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. 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://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 72826-1 | |||||
| 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 | |||||
| value[x] | SΣ | 1..1 | CodeableConcept | Detailed race codes Binding: Detailed Race (required): CDC race codes that further specify the 5 OMB race category codes | ||||
| 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:PersonalCharacteristic | preferred | Pattern: personal-characteristichttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | preferred | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReasonhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationDataAbsentReasonfrom this IG | ||||
| Observation.method | extensible | SDOHCCValueSetObservationMethodhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationMethodfrom this IG | ||||
| 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 | ||||
| Observation.component:RaceDescription.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:Race.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:Race.value[x] | required | Race Category Excluding Nulls http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3 | ||||
| Observation.component:DetailedRace.code | example | Pattern: LOINC code 72826-1http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component:DetailedRace.value[x] | required | DetailedRacehttp://hl7.org/fhir/us/core/ValueSet/detailed-race |
| Id | Grade | Path(s) | Details | Requirements |
| SDOH-Obs-1 | error | Observation | Either subject or extension-Observation.subject must exist but not both : subject.exists() xor extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.subject').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() | |
| SDOH-Race-1 | error | Observation | Must have either a dataAbsentReason or at least one of the defined race components but not both : dataAbsentReason.exists() xor component.where(code.coding.exists(system='http://loinc.org' and code='72826-1')).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
Summary
Mandatory: 1 element (3 nested mandatory elements)
Must-Support: 10 elements
Prohibited: 10 elements
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.1.0 based on FHIR 4.0.1. Generated 2024-03-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change