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-Group | Version: 2.0.0 | |||
| Draft as of 2022-11-21 | Computable Name: SDOHCCGroup | |||
Profile for identifying groups of patients who have a Social Determinants of Health (SDOH) condition and are members of a specific payer organization.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Group | 0..* | Group | This is an abstract profile. Group of SDOH patients for a payer | |
  active | 1..1 | boolean | Whether this group's record is in active use Fixed Value: true | |
| type | 1..1 | code | person Fixed Value: person | |
| actual | 1..1 | boolean | Descriptive or actual Fixed Value: true | |
  Slices for characteristic | 2..* | BackboneElement | Include / Exclude group members by Trait Slice: Unordered, Open by pattern:code | |
   characteristic:HasSDOHCondition | S | 1..1 | BackboneElement | Include / Exclude group members by Trait |
  code | S | 1..1 | CodeableConcept | Kind of characteristic 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: sdoh-condition-category | |
 value[x] | S | 1..1 | Reference(ValueSet) | Value held by characteristic Required Pattern: At least the following |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
 exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false |
 period | 0..0 | |||
 characteristic:HasPayer | S | 1..1 | BackboneElement | Include / Exclude group members by Trait |
| code | S | 1..1 | CodeableConcept | Kind of characteristic 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: payer-coverage | |
| value[x] | S | 1..1 | Reference(US Core Organization Profile) | Value held by characteristic |
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false |
| period | 0..0 | |||
| member | S | 0..* | BackboneElement | Who or what is in group |
| entity | S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | C | 0..* | Group | This is an abstract profile. Group of SDOH patients for a payer |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| active | Σ | 1..1 | boolean | Whether this group's record is in active use Fixed Value: true |
| type | Σ | 1..1 | code | person Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual | ΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| Slices for characteristic | 2..* | BackboneElement | Include / Exclude group members by Trait Slice: Unordered, Open by pattern:code | |
| characteristic:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 code | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
 value[x] | 1..1 | Value held by characteristic Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||
| valueCodeableConcept | CodeableConcept | |||
| valueBoolean | boolean | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference(Any) | |||
 exclude | 1..1 | boolean | Group includes or excludes | |
| characteristic:HasSDOHCondition | S | 1..1 | BackboneElement | Include / Exclude group members by Trait |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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: sdoh-condition-category | |
| value[x] | S | 1..1 | Reference(ValueSet) | Value held by characteristic Required Pattern: At least the following |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false |
| characteristic:HasPayer | S | 1..1 | BackboneElement | Include / Exclude group members by Trait |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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: payer-coverage | |
| value[x] | S | 1..1 | Reference(US Core Organization Profile) | Value held by characteristic |
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false |
| member | SC | 0..* | BackboneElement | Who or what is in group |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity | S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Group.type | required | Fixed Value: person |
| Group.characteristic.code | example | |
| Group.characteristic.value[x] | example | |
| Group.characteristic:HasSDOHCondition.code | example | Pattern: sdoh-condition-category |
| Group.characteristic:HasPayer.code | example | Pattern: payer-coverage |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | Group | 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 | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | 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() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Group | C | 0..* | Group | This is an abstract profile. Group of SDOH patients for a payer | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique id | ||||
| active | Σ | 1..1 | boolean | Whether this group's record is in active use Fixed Value: true | ||||
| type | Σ | 1..1 | code | person Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
| actual | ΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true | ||||
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name | Σ | 0..1 | string | Label for Group | ||||
| quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
| Slices for characteristic | 2..* | BackboneElement | Include / Exclude group members by Trait Slice: Unordered, Open by pattern:code | |||||
| characteristic:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
| value[x] | 1..1 | Value held by characteristic Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueBoolean | boolean | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueReference | Reference(Any) | |||||||
| exclude | 1..1 | boolean | Group includes or excludes | |||||
| period | 0..1 | Period | Period over which characteristic is tested | |||||
| characteristic:HasSDOHCondition | S | 1..1 | BackboneElement | Include / Exclude group members by Trait | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | S | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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: sdoh-condition-category | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | S | 1..1 | Reference(ValueSet) | Value held by characteristic Required Pattern: At least the following | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |||||
| type | 0..1 | uri | Type the reference refers to (e.g. "Patient") | |||||
| identifier | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display | 0..1 | string | Text alternative for the resource | |||||
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false | ||||
| characteristic:HasPayer | S | 1..1 | BackboneElement | Include / Exclude group members by Trait | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | S | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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: payer-coverage | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | S | 1..1 | Reference(US Core Organization Profile) | Value held by characteristic | ||||
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false | ||||
| member | SC | 0..* | BackboneElement | Who or what is in group | ||||
| 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 | ||||
| entity | S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | ||||
| period | 0..1 | Period | Period member belonged to the group | |||||
| inactive | 0..1 | boolean | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Group.language | preferred | CommonLanguages
| ||||
| Group.type | required | Fixed Value: person | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example | |||||
| Group.characteristic:HasSDOHCondition.code | example | Pattern: sdoh-condition-category | ||||
| Group.characteristic:HasPayer.code | example | Pattern: payer-coverage |
| 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 Group
Summary
Mandatory: 3 elements
Must-Support: 10 elements
Fixed Value: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | 0..* | Group | This is an abstract profile. Group of SDOH patients for a payer | |
| active | 1..1 | boolean | Whether this group's record is in active use Fixed Value: true | |
| type | 1..1 | code | person Fixed Value: person | |
| actual | 1..1 | boolean | Descriptive or actual Fixed Value: true | |
| Slices for characteristic | 2..* | BackboneElement | Include / Exclude group members by Trait Slice: Unordered, Open by pattern:code | |
| characteristic:HasSDOHCondition | S | 1..1 | BackboneElement | Include / Exclude group members by Trait |
| code | S | 1..1 | CodeableConcept | Kind of characteristic 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: sdoh-condition-category | |
| value[x] | S | 1..1 | Reference(ValueSet) | Value held by characteristic Required Pattern: At least the following |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false |
| period | 0..0 | |||
| characteristic:HasPayer | S | 1..1 | BackboneElement | Include / Exclude group members by Trait |
| code | S | 1..1 | CodeableConcept | Kind of characteristic 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: payer-coverage | |
| value[x] | S | 1..1 | Reference(US Core Organization Profile) | Value held by characteristic |
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false |
| period | 0..0 | |||
| member | S | 0..* | BackboneElement | Who or what is in group |
| entity | S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | C | 0..* | Group | This is an abstract profile. Group of SDOH patients for a payer |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| active | Σ | 1..1 | boolean | Whether this group's record is in active use Fixed Value: true |
| type | Σ | 1..1 | code | person Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual | ΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| Slices for characteristic | 2..* | BackboneElement | Include / Exclude group members by Trait Slice: Unordered, Open by pattern:code | |
| characteristic:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
| value[x] | 1..1 | Value held by characteristic Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||
| valueCodeableConcept | CodeableConcept | |||
| valueBoolean | boolean | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference(Any) | |||
| exclude | 1..1 | boolean | Group includes or excludes | |
| characteristic:HasSDOHCondition | S | 1..1 | BackboneElement | Include / Exclude group members by Trait |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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: sdoh-condition-category | |
| value[x] | S | 1..1 | Reference(ValueSet) | Value held by characteristic Required Pattern: At least the following |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false |
| characteristic:HasPayer | S | 1..1 | BackboneElement | Include / Exclude group members by Trait |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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: payer-coverage | |
| value[x] | S | 1..1 | Reference(US Core Organization Profile) | Value held by characteristic |
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false |
| member | SC | 0..* | BackboneElement | Who or what is in group |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity | S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Group.type | required | Fixed Value: person |
| Group.characteristic.code | example | |
| Group.characteristic.value[x] | example | |
| Group.characteristic:HasSDOHCondition.code | example | Pattern: sdoh-condition-category |
| Group.characteristic:HasPayer.code | example | Pattern: payer-coverage |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | Group | 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 | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | 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() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Group | C | 0..* | Group | This is an abstract profile. Group of SDOH patients for a payer | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique id | ||||
| active | Σ | 1..1 | boolean | Whether this group's record is in active use Fixed Value: true | ||||
| type | Σ | 1..1 | code | person Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
| actual | ΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true | ||||
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name | Σ | 0..1 | string | Label for Group | ||||
| quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
| Slices for characteristic | 2..* | BackboneElement | Include / Exclude group members by Trait Slice: Unordered, Open by pattern:code | |||||
| characteristic:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
| value[x] | 1..1 | Value held by characteristic Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueBoolean | boolean | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueReference | Reference(Any) | |||||||
| exclude | 1..1 | boolean | Group includes or excludes | |||||
| period | 0..1 | Period | Period over which characteristic is tested | |||||
| characteristic:HasSDOHCondition | S | 1..1 | BackboneElement | Include / Exclude group members by Trait | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | S | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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: sdoh-condition-category | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | S | 1..1 | Reference(ValueSet) | Value held by characteristic Required Pattern: At least the following | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory | |||||
| type | 0..1 | uri | Type the reference refers to (e.g. "Patient") | |||||
| identifier | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display | 0..1 | string | Text alternative for the resource | |||||
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false | ||||
| characteristic:HasPayer | S | 1..1 | BackboneElement | Include / Exclude group members by Trait | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | S | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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: payer-coverage | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | S | 1..1 | Reference(US Core Organization Profile) | Value held by characteristic | ||||
| exclude | S | 1..1 | boolean | Group includes or excludes Fixed Value: false | ||||
| member | SC | 0..* | BackboneElement | Who or what is in group | ||||
| 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 | ||||
| entity | S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | ||||
| period | 0..1 | Period | Period member belonged to the group | |||||
| inactive | 0..1 | boolean | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Group.language | preferred | CommonLanguages
| ||||
| Group.type | required | Fixed Value: person | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example | |||||
| Group.characteristic:HasSDOHCondition.code | example | Pattern: sdoh-condition-category | ||||
| Group.characteristic:HasPayer.code | example | Pattern: payer-coverage |
| 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 Group
Summary
Mandatory: 3 elements
Must-Support: 10 elements
Fixed Value: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 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