This page is part of the SDOH Clinical Care for Multiple Domains (v2.1.0: STU 2.1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB | Version: 2.1.0 | |||
Draft as of 2023-07-27 | 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 |
Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReason |
Observation.method | extensible | SDOHCCValueSetObservationMethod |
Observation.component:Race.value[x] | required | Race Category Excluding Nulls |
Observation.component:DetailedRace.value[x] | required | DetailedRace |
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 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) | Extension 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 |
Observation.status | required | SDOHCCValueSetObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:PersonalCharacteristic | preferred | Pattern: personal-characteristic |
Observation.code | preferred | Pattern: LOINC code 72826-1 |
Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReason |
Observation.method | extensible | SDOHCCValueSetObservationMethod |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component:RaceDescription.code | example | Pattern: LOINC code 72826-1 |
Observation.component:Race.code | example | Pattern: LOINC code 72826-1 |
Observation.component:Race.value[x] | required | Race Category Excluding Nulls |
Observation.component:DetailedRace.code | example | Pattern: LOINC code 72826-1 |
Observation.component:DetailedRace.value[x] | required | DetailedRace |
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 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) | Extension 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 | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | SDOHCCValueSetObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.category:PersonalCharacteristic | preferred | Pattern: personal-characteristic | ||||
Observation.code | preferred | Pattern: LOINC code 72826-1 | ||||
Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReason | ||||
Observation.method | extensible | SDOHCCValueSetObservationMethod | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:RaceDescription.code | example | Pattern: LOINC code 72826-1 | ||||
Observation.component:Race.code | example | Pattern: LOINC code 72826-1 | ||||
Observation.component:Race.value[x] | required | Race Category Excluding Nulls | ||||
Observation.component:DetailedRace.code | example | Pattern: LOINC code 72826-1 | ||||
Observation.component:DetailedRace.value[x] | required | DetailedRace |
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 |
Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReason |
Observation.method | extensible | SDOHCCValueSetObservationMethod |
Observation.component:Race.value[x] | required | Race Category Excluding Nulls |
Observation.component:DetailedRace.value[x] | required | DetailedRace |
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 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) | Extension 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 |
Observation.status | required | SDOHCCValueSetObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:PersonalCharacteristic | preferred | Pattern: personal-characteristic |
Observation.code | preferred | Pattern: LOINC code 72826-1 |
Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReason |
Observation.method | extensible | SDOHCCValueSetObservationMethod |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component:RaceDescription.code | example | Pattern: LOINC code 72826-1 |
Observation.component:Race.code | example | Pattern: LOINC code 72826-1 |
Observation.component:Race.value[x] | required | Race Category Excluding Nulls |
Observation.component:DetailedRace.code | example | Pattern: LOINC code 72826-1 |
Observation.component:DetailedRace.value[x] | required | DetailedRace |
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() |
Snapshot View
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 | ||||
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) | Extension 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 | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | SDOHCCValueSetObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.category:PersonalCharacteristic | preferred | Pattern: personal-characteristic | ||||
Observation.code | preferred | Pattern: LOINC code 72826-1 | ||||
Observation.dataAbsentReason | required | SDOHCCValueSetObservationDataAbsentReason | ||||
Observation.method | extensible | SDOHCCValueSetObservationMethod | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:RaceDescription.code | example | Pattern: LOINC code 72826-1 | ||||
Observation.component:Race.code | example | Pattern: LOINC code 72826-1 | ||||
Observation.component:Race.value[x] | required | Race Category Excluding Nulls | ||||
Observation.component:DetailedRace.code | example | Pattern: LOINC code 72826-1 | ||||
Observation.component:DetailedRace.value[x] | required | DetailedRace |
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