SDOH Clinical Care
2.0.0 - STU 2
US
SDOH Clinical Care
2.0.0 - STU 2
US
This page is part of the SDOH Clinical Care for Multiple Domains (v2.0.0: STU 2) 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-ObservationGenderIdentity | Version: 2.0.0 | |||
| Draft as of 2022-11-21 | Computable Name: SDOHCCObservationGenderIdentity | |||
Profile for gender identity observations which are based on a person’s inner sense of being a girl/woman/female/feminine, boy/man/male/masculine, nonbinary, something else, or having no gender. This profile is intended for draft use only. The Cross-Group Projects work group granted a variance to US Core on 06/23/2022 - Jira ticket FHIR-37582. 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 | 0..* | SDOHCCObservationPersonalCharacteristic | Profile for observations about gender identity. | |
  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: 76691-5 | |
| value[x] | 1..1 | CodeableConcept | Actual result Binding: Gender Identity (preferred): Codes for self-identified gender, plus unknown and other | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 DataAbsentReasonMasked | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
 value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| coding | S | 0..* | Coding | Code defined by a terminology system |
| dataAbsentReason | 0..0 | |||
| method | S | 1..1 | CodeableConcept | How it was done Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.value[x] | preferred | Gender Identity |
| Observation.method | extensible | SDOHCCValueSetObservationMethod |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | SDOHCCObservationPersonalCharacteristic | Profile for observations about gender identity. |
 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) 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: 76691-5 | |
| 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 |
| value[x] | SΣC | 1..1 | CodeableConcept | Actual result Binding: Gender Identity (preferred): Codes for self-identified gender, plus unknown and other |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| DataAbsentReasonMasked | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| 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 |
| 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 76691-5 |
| Observation.value[x] | preferred | Gender Identity |
| Observation.value[x].extension:DataAbsentReasonMasked.value[x] | required | Fixed Value: masked |
| Observation.method | extensible | SDOHCCValueSetObservationMethod |
| 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() | |
| 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 | Profile for observations about gender identity. | ||||
| 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 | id | 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 | id | 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) Required Pattern: At least the following | ||||
| id | 0..1 | id | 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 | id | 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: 76691-5 | |||||
| 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 | ||||
| value[x] | SΣC | 1..1 | CodeableConcept | Actual result Binding: Gender Identity (preferred): Codes for self-identified gender, plus unknown and other | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| DataAbsentReasonMasked | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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 | ||||
| component | Σ | 0..* | BackboneElement | Component results | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| 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 76691-5 | ||||
| Observation.value[x] | preferred | Gender Identity | ||||
| Observation.value[x].extension:DataAbsentReasonMasked.value[x] | required | Fixed Value: masked | ||||
| 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 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from SDOHCCObservationPersonalCharacteristic
Differential View
This structure is derived from SDOHCCObservationPersonalCharacteristic
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | SDOHCCObservationPersonalCharacteristic | Profile for observations about gender identity. | |
| 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: 76691-5 | |
| value[x] | 1..1 | CodeableConcept | Actual result Binding: Gender Identity (preferred): Codes for self-identified gender, plus unknown and other | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| DataAbsentReasonMasked | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| coding | S | 0..* | Coding | Code defined by a terminology system |
| dataAbsentReason | 0..0 | |||
| method | S | 1..1 | CodeableConcept | How it was done Binding: SDOHCC ValueSet Observation Method (extensible): Methods for personal characteristic observations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.value[x] | preferred | Gender Identity |
| Observation.method | extensible | SDOHCCValueSetObservationMethod |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | SDOHCCObservationPersonalCharacteristic | Profile for observations about gender identity. |
| 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) 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: 76691-5 | |
| 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 |
| value[x] | SΣC | 1..1 | CodeableConcept | Actual result Binding: Gender Identity (preferred): Codes for self-identified gender, plus unknown and other |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| DataAbsentReasonMasked | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| 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 |
| 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 76691-5 |
| Observation.value[x] | preferred | Gender Identity |
| Observation.value[x].extension:DataAbsentReasonMasked.value[x] | required | Fixed Value: masked |
| Observation.method | extensible | SDOHCCValueSetObservationMethod |
| 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() | |
| 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 | Profile for observations about gender identity. | ||||
| 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 | id | 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 | id | 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) Required Pattern: At least the following | ||||
| id | 0..1 | id | 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 | id | 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: 76691-5 | |||||
| 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 | ||||
| value[x] | SΣC | 1..1 | CodeableConcept | Actual result Binding: Gender Identity (preferred): Codes for self-identified gender, plus unknown and other | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| DataAbsentReasonMasked | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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 | ||||
| component | Σ | 0..* | BackboneElement | Component results | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| 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 76691-5 | ||||
| Observation.value[x] | preferred | Gender Identity | ||||
| Observation.value[x].extension:DataAbsentReasonMasked.value[x] | required | Fixed Value: masked | ||||
| 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 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from SDOHCCObservationPersonalCharacteristic
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International - Patient Care WG. Package hl7.fhir.us.sdoh-clinicalcare#2.0.0 based on FHIR 4.0.1. Generated 2022-11-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change