1.6.3 - release
SHINNYHRSN - Local Development build (v1.6.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://shinny.org/us/ny/hrsn/StructureDefinition/shinny-observation-screening-response | Version: 1.6.3 | |||
| Active as of 2025-10-01 | Computable Name: SHINNYObservationScreeningResponse | |||
The SHINNY Observation Screening Response Profile inherits from the SDOH Clinical Care Observation Screening Response profile. This profile is intended to represent question-answer pairs from Social Determinants of Health (SDOH) assessment instruments.
For a complete description of usage, please reference the details documented within the SDOH Clinical Care Implementation Guide
Note that within the SHINNYLanguageVS value set there are two different links to language standards. Within the FHIR documentation, currently there is no way of navitaging directly to the complete list of "All Languages", which can be found here.
It's also important to note there are two language attributes within the patient resource. The "language" attribute within all resources describes the language of the FHIR IG itself. For the SHIN-NY IG, this should always be "en" for English. The communication.language is described as, "The language which can be used to communicate with the patient about his or her health." For this attribute, any of the languages found in the list of "All Languages", referenced above, can be used.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | SDOHCCObservationScreeningResponse | SDOH screening questionnaire observations Constraints: obs-6, obs-7, Observation-PerformerOrganizationScreening, SHINNYScreeningHousingComponent |
![]() ![]() |
SΣ | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
![]() ![]() |
SΣ | 1..1 | SHINNYMeta | Metadata about the resource |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred) | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | CodeableConcept | SHINNY Observation Language URL: http://shinny.org/us/ny/hrsn/StructureDefinition/shinny-observation-language Binding: SHINNYLanguageVS (preferred): ObservationLanguage | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) |
![]() ![]() |
3..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | SNOMED CT codes associated with SDOH category. Binding: SHINNYSNOMEDSDOHCategory (required): SNOMED codes descirbing a specific SDOH category when that category is not locally defined. |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations. |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | If present, this MUST match the long description name provided by the source system |
![]() ![]() ![]() |
Σ | 0..1 | string | This is the human readable question that is presented to the patient and should be present |
![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about |
![]() ![]() |
SΣ | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() |
SΣ | 1..1 | Clinically relevant time/time-period for observation | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SΣ | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation |
![]() ![]() |
SΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() |
time | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | This is the human readable answer that is presented to the patient and MUST be present |
![]() ![]() ![]() |
ΣC | 0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. |
![]() ![]() |
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument |
![]() ![]() |
SΣ | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatus | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SocialHistory | preferred | Pattern Value: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:Survey | preferred | Pattern Value: surveyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| Observation.category:SNOMED | required | SHINNYSNOMEDSDOHCategory(a valid code from SNOMED CT)http://shinny.org/us/ny/hrsn/ValueSet/SHINNYSNOMEDSDOHCategoryFrom this IG | |
| Observation.code | required | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive(a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| Observation-PerformerOrganizationScreening | error | Observation | All grouper screening observations must include a performer that references an organization. : hasMember.exists() implies (performer.reference.where ($this.contains ('Organization')).count() > 0 or performer.type.where ($this.contains ('Organization')).count() > 0) | |
| SHINNYScreeningHousingComponent | error | Observation | All housing adequacy questions with code 96778-6, with a response value, require values as components. : where(code.coding.code contains '96778-6').exists() and dataAbsentReason.empty() and component.dataAbsentReason.empty() implies component.select(code.coding).where(code = '96778-6') and component.select(value).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 SDOHCCObservationScreeningResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | SDOHCCObservationScreeningResponse | SDOH screening questionnaire observations Constraints: Observation-PerformerOrganizationScreening, SHINNYScreeningHousingComponent |
![]() ![]() |
S | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
![]() ![]() |
S | 1..1 | SHINNYMeta | Metadata about the resource |
![]() ![]() |
0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred) | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | CodeableConcept | SHINNY Observation Language URL: http://shinny.org/us/ny/hrsn/StructureDefinition/shinny-observation-language Binding: SHINNYLanguageVS (preferred): ObservationLanguage | |
![]() ![]() |
3..* | CodeableConcept | Classification of type of observation | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity | |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | SNOMED CT codes associated with SDOH category. Binding: SHINNYSNOMEDSDOHCategory (required): SNOMED codes descirbing a specific SDOH category when that category is not locally defined. |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
0..1 | string | If present, this MUST match the long description name provided by the source system | |
![]() ![]() ![]() |
0..1 | string | This is the human readable question that is presented to the patient and should be present | |
![]() ![]() |
S | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | CodeableConcept | Actual result | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | This MUST match the long description name provided by the source system | |
![]() ![]() ![]() ![]() |
0..1 | string | This is the human readable answer that is presented to the patient and MUST be present | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| Observation.category:SNOMED | required | SHINNYSNOMEDSDOHCategory(a valid code from SNOMED CT)http://shinny.org/us/ny/hrsn/ValueSet/SHINNYSNOMEDSDOHCategoryFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| Observation-PerformerOrganizationScreening | error | Observation | All grouper screening observations must include a performer that references an organization. : hasMember.exists() implies (performer.reference.where ($this.contains ('Organization')).count() > 0 or performer.type.where ($this.contains ('Organization')).count() > 0) | |
| SHINNYScreeningHousingComponent | error | Observation | All housing adequacy questions with code 96778-6, with a response value, require values as components. : where(code.coding.code contains '96778-6').exists() and dataAbsentReason.empty() and component.dataAbsentReason.empty() implies component.select(code.coding).where(code = '96778-6') and component.select(value).exists() |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | SDOHCCObservationScreeningResponse | SDOH screening questionnaire observations Constraints: obs-6, obs-7, Observation-PerformerOrganizationScreening, SHINNYScreeningHousingComponent |
![]() ![]() |
SΣ | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
![]() ![]() |
SΣ | 1..1 | SHINNYMeta | Metadata about the resource |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred) | |
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | CodeableConcept | SHINNY Observation Language URL: http://shinny.org/us/ny/hrsn/StructureDefinition/shinny-observation-language Binding: SHINNYLanguageVS (preferred): ObservationLanguage | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for observation |
![]() ![]() |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
![]() ![]() |
?!SΣ | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) |
![]() ![]() |
3..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | SNOMED CT codes associated with SDOH category. Binding: SHINNYSNOMEDSDOHCategory (required): SNOMED codes descirbing a specific SDOH category when that category is not locally defined. |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations. |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | If present, this MUST match the long description name provided by the source system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() |
Σ | 0..1 | string | This is the human readable question that is presented to the patient and should be present |
![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about |
![]() ![]() |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
![]() ![]() |
SΣ | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() |
SΣ | 1..1 | Clinically relevant time/time-period for observation | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available |
![]() ![]() |
SΣ | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation |
![]() ![]() |
SΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() |
time | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | This MUST match the long description name provided by the source system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | This is the human readable answer that is presented to the patient and MUST be present |
![]() ![]() ![]() |
ΣC | 0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. |
![]() ![]() |
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() |
0..* | Annotation | Comments about the observation | |
![]() ![]() |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
![]() ![]() |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
![]() ![]() ![]() |
0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |
![]() ![]() |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument |
![]() ![]() |
SΣ | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from |
![]() ![]() |
Σ | 0..* | BackboneElement | Component results |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() |
Σ | 0..1 | Actual component result | |
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatus | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SocialHistory | preferred | Pattern Value: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:Survey | preferred | Pattern Value: surveyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| Observation.category:SNOMED | required | SHINNYSNOMEDSDOHCategory(a valid code from SNOMED CT)http://shinny.org/us/ny/hrsn/ValueSet/SHINNYSNOMEDSDOHCategoryFrom this IG | |
| Observation.code | required | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive(a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | |
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | |
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsFrom the FHIR Standard | |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | |
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard | |
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | |
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| Observation-PerformerOrganizationScreening | error | Observation | All grouper screening observations must include a performer that references an organization. : hasMember.exists() implies (performer.reference.where ($this.contains ('Organization')).count() > 0 or performer.type.where ($this.contains ('Organization')).count() > 0) | |
| SHINNYScreeningHousingComponent | error | Observation | All housing adequacy questions with code 96778-6, with a response value, require values as components. : where(code.coding.code contains '96778-6').exists() and dataAbsentReason.empty() and component.dataAbsentReason.empty() implies component.select(code.coding).where(code = '96778-6') and component.select(value).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-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from SDOHCCObservationScreeningResponse
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | SDOHCCObservationScreeningResponse | SDOH screening questionnaire observations Constraints: obs-6, obs-7, Observation-PerformerOrganizationScreening, SHINNYScreeningHousingComponent |
![]() ![]() |
SΣ | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
![]() ![]() |
SΣ | 1..1 | SHINNYMeta | Metadata about the resource |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred) | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | CodeableConcept | SHINNY Observation Language URL: http://shinny.org/us/ny/hrsn/StructureDefinition/shinny-observation-language Binding: SHINNYLanguageVS (preferred): ObservationLanguage | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) |
![]() ![]() |
3..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | SNOMED CT codes associated with SDOH category. Binding: SHINNYSNOMEDSDOHCategory (required): SNOMED codes descirbing a specific SDOH category when that category is not locally defined. |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations. |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | If present, this MUST match the long description name provided by the source system |
![]() ![]() ![]() |
Σ | 0..1 | string | This is the human readable question that is presented to the patient and should be present |
![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about |
![]() ![]() |
SΣ | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() |
SΣ | 1..1 | Clinically relevant time/time-period for observation | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SΣ | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation |
![]() ![]() |
SΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() |
time | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | This is the human readable answer that is presented to the patient and MUST be present |
![]() ![]() ![]() |
ΣC | 0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. |
![]() ![]() |
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument |
![]() ![]() |
SΣ | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatus | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SocialHistory | preferred | Pattern Value: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:Survey | preferred | Pattern Value: surveyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| Observation.category:SNOMED | required | SHINNYSNOMEDSDOHCategory(a valid code from SNOMED CT)http://shinny.org/us/ny/hrsn/ValueSet/SHINNYSNOMEDSDOHCategoryFrom this IG | |
| Observation.code | required | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive(a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| Observation-PerformerOrganizationScreening | error | Observation | All grouper screening observations must include a performer that references an organization. : hasMember.exists() implies (performer.reference.where ($this.contains ('Organization')).count() > 0 or performer.type.where ($this.contains ('Organization')).count() > 0) | |
| SHINNYScreeningHousingComponent | error | Observation | All housing adequacy questions with code 96778-6, with a response value, require values as components. : where(code.coding.code contains '96778-6').exists() and dataAbsentReason.empty() and component.dataAbsentReason.empty() implies component.select(code.coding).where(code = '96778-6') and component.select(value).exists() | |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
Differential View
This structure is derived from SDOHCCObservationScreeningResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | SDOHCCObservationScreeningResponse | SDOH screening questionnaire observations Constraints: Observation-PerformerOrganizationScreening, SHINNYScreeningHousingComponent |
![]() ![]() |
S | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
![]() ![]() |
S | 1..1 | SHINNYMeta | Metadata about the resource |
![]() ![]() |
0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred) | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | CodeableConcept | SHINNY Observation Language URL: http://shinny.org/us/ny/hrsn/StructureDefinition/shinny-observation-language Binding: SHINNYLanguageVS (preferred): ObservationLanguage | |
![]() ![]() |
3..* | CodeableConcept | Classification of type of observation | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity | |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | SNOMED CT codes associated with SDOH category. Binding: SHINNYSNOMEDSDOHCategory (required): SNOMED codes descirbing a specific SDOH category when that category is not locally defined. |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
0..1 | string | If present, this MUST match the long description name provided by the source system | |
![]() ![]() ![]() |
0..1 | string | This is the human readable question that is presented to the patient and should be present | |
![]() ![]() |
S | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | CodeableConcept | Actual result | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | This MUST match the long description name provided by the source system | |
![]() ![]() ![]() ![]() |
0..1 | string | This is the human readable answer that is presented to the patient and MUST be present | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| Observation.category:SNOMED | required | SHINNYSNOMEDSDOHCategory(a valid code from SNOMED CT)http://shinny.org/us/ny/hrsn/ValueSet/SHINNYSNOMEDSDOHCategoryFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| Observation-PerformerOrganizationScreening | error | Observation | All grouper screening observations must include a performer that references an organization. : hasMember.exists() implies (performer.reference.where ($this.contains ('Organization')).count() > 0 or performer.type.where ($this.contains ('Organization')).count() > 0) | |
| SHINNYScreeningHousingComponent | error | Observation | All housing adequacy questions with code 96778-6, with a response value, require values as components. : where(code.coding.code contains '96778-6').exists() and dataAbsentReason.empty() and component.dataAbsentReason.empty() implies component.select(code.coding).where(code = '96778-6') and component.select(value).exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | SDOHCCObservationScreeningResponse | SDOH screening questionnaire observations Constraints: obs-6, obs-7, Observation-PerformerOrganizationScreening, SHINNYScreeningHousingComponent |
![]() ![]() |
SΣ | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
![]() ![]() |
SΣ | 1..1 | SHINNYMeta | Metadata about the resource |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred) | |
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | CodeableConcept | SHINNY Observation Language URL: http://shinny.org/us/ny/hrsn/StructureDefinition/shinny-observation-language Binding: SHINNYLanguageVS (preferred): ObservationLanguage | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for observation |
![]() ![]() |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
![]() ![]() |
?!SΣ | 1..1 | code | final | corrected | entered-in-error | unknown Binding: SDOHCC ValueSet Observation Status (required) |
![]() ![]() |
3..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: social-history | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: survey | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | SNOMED CT codes associated with SDOH category. Binding: SHINNYSNOMEDSDOHCategory (required): SNOMED codes descirbing a specific SDOH category when that category is not locally defined. |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (required): Codes identifying names of simple observations. |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | If present, this MUST match the long description name provided by the source system |
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() |
Σ | 0..1 | string | This is the human readable question that is presented to the patient and should be present |
![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about |
![]() ![]() |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
![]() ![]() |
SΣ | 1..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() |
SΣ | 1..1 | Clinically relevant time/time-period for observation | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available |
![]() ![]() |
SΣ | 0..* | Reference(RelatedPerson | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile) | Who is responsible for the observation |
![]() ![]() |
SΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() |
time | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | Actual result Binding: LOINCCodes (preferred): This value set includes all LOINC codes |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | This MUST match the long description name provided by the source system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | This is the human readable answer that is presented to the patient and MUST be present |
![]() ![]() ![]() |
ΣC | 0..1 | Quantity | Actual result Binding: UnitsOfMeasureCaseSensitive (required): This is the entire UCUM code set. |
![]() ![]() |
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() |
0..* | Annotation | Comments about the observation | |
![]() ![]() |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
![]() ![]() |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
![]() ![]() ![]() |
0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |
![]() ![]() |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | References the child observations of a grouping observation Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response) | For an Observation Grouping, the Observations generated from an assessment instrument |
![]() ![]() |
SΣ | 0..* | Reference(DocumentReference | QuestionnaireResponse | Observation) | Related measurements the observation is made from Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Observation Screening Response | SDC Questionnaire Response) | Related questionnaire responses or observations that the observation is made from |
![]() ![]() |
Σ | 0..* | BackboneElement | Component results |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() |
Σ | 0..1 | Actual component result | |
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.language | preferred | SHINNYLanguageVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVSFrom this IG | |
| Observation.status | required | SDOHCCValueSetObservationStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetObservationStatus | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SocialHistory | preferred | Pattern Value: social-historyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:Survey | preferred | Pattern Value: surveyhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:SDOH | required | SDOHCCValueSetSDOHCategoryhttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| Observation.category:SNOMED | required | SHINNYSNOMEDSDOHCategory(a valid code from SNOMED CT)http://shinny.org/us/ny/hrsn/ValueSet/SHINNYSNOMEDSDOHCategoryFrom this IG | |
| Observation.code | required | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueCodeableConcept | preferred | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.value[x]:valueQuantity | required | UnitsOfMeasureCaseSensitive(a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | |
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | |
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | |
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsFrom the FHIR Standard | |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard | |
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard | |
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard | |
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard | |
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| Observation-PerformerOrganizationScreening | error | Observation | All grouper screening observations must include a performer that references an organization. : hasMember.exists() implies (performer.reference.where ($this.contains ('Organization')).count() > 0 or performer.type.where ($this.contains ('Organization')).count() > 0) | |
| SHINNYScreeningHousingComponent | error | Observation | All housing adequacy questions with code 96778-6, with a response value, require values as components. : where(code.coding.code contains '96778-6').exists() and dataAbsentReason.empty() and component.dataAbsentReason.empty() implies component.select(code.coding).where(code = '96778-6') and component.select(value).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-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from SDOHCCObservationScreeningResponse
Other representations of profile: CSV, Excel, Schematron