SDOH Clinical Care
3.1.0 - STU 3.1 Draft United States of America flag

SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-sdoh-clinicalcare/ and changes regularly. See the Directory of published versions

Resource Profile: SDOHCC Group

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Group Version: 3.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: SDOHCCGroup
Other Identifiers: OID:2.16.840.1.113883.4.642.40.6.42.7

Profile for identifying groups of patients who have a Social Determinants of Health (SDOH) condition and are members of a specific payer organization.

Purpose

SDOHCC Group is intended to support identification of cohorts of individuals who have conditions in the same SDOH category (domain) AND are members of the same specific payer organization. (See Gravity Use Case Package Use Case 3 which involves aggregation and analysis of individual-level social risk and need data to support clinical, system, and community activities.) The two required slices on Group.characteristic can be used to identify a cohort of subjects who have coverage through a specific payer organization AND a condition that falls into a specified SDOH category/domain.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* Group Group of SDOH patients for a payer
Constraints: grp-1
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.active This element is included in summaries. 1..1 boolean Whether this group's record is in active use
Fixed Value: true (no extensions allowed)
Group.type This element is included in summaries. 1..1 code person
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person (no extensions allowed)
Group.actual This element is included in summaries. C 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
Group.Slices for characteristic.characteristic:All Slices Content/Rules for all slices
Group.Slices for characteristic.characteristic:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:All Slices.code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Group.Slices for characteristic.characteristic:All Slices.value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
Group.Slices for characteristic.characteristic:All Slices.value[x].valueCodeableConcept CodeableConcept
Group.Slices for characteristic.characteristic:All Slices.value[x].valueBoolean boolean
Group.Slices for characteristic.characteristic:All Slices.value[x].valueQuantity Quantity
Group.Slices for characteristic.characteristic:All Slices.value[x].valueRange Range
Group.Slices for characteristic.characteristic:All Slices.value[x].valueReference Reference(Any)
Group.Slices for characteristic.characteristic:All Slices.exclude 1..1 boolean Group includes or excludes
Group.Slices for characteristic.characteristic:HasSDOHCondition This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasSDOHCondition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:HasSDOHCondition.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "sdoh-condition-category"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasSDOHCondition.value[x] This element must be supported. 1..1 CodeableConcept Value held by characteristic
Binding: SDOHCC ValueSet SDOH Category (extensible)
Group.Slices for characteristic.characteristic:HasSDOHCondition.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.Slices for characteristic.characteristic:HasPayer This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasPayer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:HasPayer.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "payer-coverage"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasPayer.value[x] This element must be supported. 1..1 Reference(US Core Organization Profile(7.0.0)) Value held by characteristic
Group.Slices for characteristic.characteristic:HasPayer.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.member This element must be supported. C 0..* BackboneElement Who or what is in group
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic:HasSDOHCondition.​code Base example Not State Unknown
Group.characteristic:HasSDOHCondition.​value[x] Base extensible SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Group.characteristic:HasPayer.​code Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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)

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group Group of SDOH patients for a payer
Group.active 1..1 boolean Whether this group's record is in active use
Fixed Value: true (no extensions allowed)
Group.type 1..1 code person
Fixed Value: person (no extensions allowed)
Group.actual 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.Slices for characteristic.characteristic:HasSDOHCondition This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasSDOHCondition.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "sdoh-condition-category"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasSDOHCondition.value[x] This element must be supported. 1..1 CodeableConcept Value held by characteristic
Binding: SDOHCC ValueSet SDOH Category (extensible)
Group.Slices for characteristic.characteristic:HasSDOHCondition.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.Slices for characteristic.characteristic:HasSDOHCondition.period 0..0 Period over which characteristic is tested
Group.Slices for characteristic.characteristic:HasPayer This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasPayer.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "payer-coverage"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasPayer.value[x] This element must be supported. 1..1 Reference(US Core Organization Profile(7.0.0)) Value held by characteristic
Group.Slices for characteristic.characteristic:HasPayer.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.Slices for characteristic.characteristic:HasPayer.period 0..0 Period over which characteristic is tested
Group.member This element must be supported. 0..* BackboneElement Who or what is in group
Group.member.entity This element must be supported. 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.characteristic:HasSDOHCondition.​value[x] Base extensible SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* Group Group of SDOH patients for a payer
Constraints: grp-1
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Group.text 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
Group.contained 0..* Resource Contained, inline Resources
Group.extension 0..* Extension Additional content defined by implementations
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.identifier This element is included in summaries. 0..* Identifier Unique id
Group.active This element is included in summaries. 1..1 boolean Whether this group's record is in active use
Fixed Value: true (no extensions allowed)
Group.type This element is included in summaries. 1..1 code person
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person (no extensions allowed)
Group.actual This element is included in summaries. C 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.code This element is included in summaries. 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
Group.name This element is included in summaries. 0..1 string Label for Group
Group.quantity This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element is included in summaries. 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
Group.Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
Group.Slices for characteristic.characteristic:All Slices Content/Rules for all slices
Group.Slices for characteristic.characteristic:All Slices.id 0..1 string Unique id for inter-element referencing
Group.Slices for characteristic.characteristic:All Slices.extension 0..* Extension Additional content defined by implementations
Group.Slices for characteristic.characteristic:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:All Slices.code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Group.Slices for characteristic.characteristic:All Slices.value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
Group.Slices for characteristic.characteristic:All Slices.value[x].valueCodeableConcept CodeableConcept
Group.Slices for characteristic.characteristic:All Slices.value[x].valueBoolean boolean
Group.Slices for characteristic.characteristic:All Slices.value[x].valueQuantity Quantity
Group.Slices for characteristic.characteristic:All Slices.value[x].valueRange Range
Group.Slices for characteristic.characteristic:All Slices.value[x].valueReference Reference(Any)
Group.Slices for characteristic.characteristic:All Slices.exclude 1..1 boolean Group includes or excludes
Group.Slices for characteristic.characteristic:All Slices.period 0..1 Period Period over which characteristic is tested
Group.Slices for characteristic.characteristic:HasSDOHCondition This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasSDOHCondition.id 0..1 string Unique id for inter-element referencing
Group.Slices for characteristic.characteristic:HasSDOHCondition.extension 0..* Extension Additional content defined by implementations
Group.Slices for characteristic.characteristic:HasSDOHCondition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:HasSDOHCondition.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "sdoh-condition-category"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasSDOHCondition.value[x] This element must be supported. 1..1 CodeableConcept Value held by characteristic
Binding: SDOHCC ValueSet SDOH Category (extensible)
Group.Slices for characteristic.characteristic:HasSDOHCondition.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.Slices for characteristic.characteristic:HasPayer This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasPayer.id 0..1 string Unique id for inter-element referencing
Group.Slices for characteristic.characteristic:HasPayer.extension 0..* Extension Additional content defined by implementations
Group.Slices for characteristic.characteristic:HasPayer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:HasPayer.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "payer-coverage"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasPayer.value[x] This element must be supported. 1..1 Reference(US Core Organization Profile(7.0.0)) Value held by characteristic
Group.Slices for characteristic.characteristic:HasPayer.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.member This element must be supported. C 0..* BackboneElement Who or what is in group
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.extension 0..* Extension Additional content defined by implementations
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
Group.member.period 0..1 Period Period member belonged to the group
Group.member.inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic:HasSDOHCondition.​code Base example Not State Unknown
Group.characteristic:HasSDOHCondition.​value[x] Base extensible SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Group.characteristic:HasPayer.​code Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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)

This structure is derived from Group

Summary

Mandatory: 3 elements
Must-Support: 10 elements
Fixed: 5 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Group.characteristic

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* Group Group of SDOH patients for a payer
Constraints: grp-1
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.active This element is included in summaries. 1..1 boolean Whether this group's record is in active use
Fixed Value: true (no extensions allowed)
Group.type This element is included in summaries. 1..1 code person
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person (no extensions allowed)
Group.actual This element is included in summaries. C 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
Group.Slices for characteristic.characteristic:All Slices Content/Rules for all slices
Group.Slices for characteristic.characteristic:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:All Slices.code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Group.Slices for characteristic.characteristic:All Slices.value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
Group.Slices for characteristic.characteristic:All Slices.value[x].valueCodeableConcept CodeableConcept
Group.Slices for characteristic.characteristic:All Slices.value[x].valueBoolean boolean
Group.Slices for characteristic.characteristic:All Slices.value[x].valueQuantity Quantity
Group.Slices for characteristic.characteristic:All Slices.value[x].valueRange Range
Group.Slices for characteristic.characteristic:All Slices.value[x].valueReference Reference(Any)
Group.Slices for characteristic.characteristic:All Slices.exclude 1..1 boolean Group includes or excludes
Group.Slices for characteristic.characteristic:HasSDOHCondition This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasSDOHCondition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:HasSDOHCondition.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "sdoh-condition-category"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasSDOHCondition.value[x] This element must be supported. 1..1 CodeableConcept Value held by characteristic
Binding: SDOHCC ValueSet SDOH Category (extensible)
Group.Slices for characteristic.characteristic:HasSDOHCondition.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.Slices for characteristic.characteristic:HasPayer This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasPayer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:HasPayer.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "payer-coverage"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasPayer.value[x] This element must be supported. 1..1 Reference(US Core Organization Profile(7.0.0)) Value held by characteristic
Group.Slices for characteristic.characteristic:HasPayer.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.member This element must be supported. C 0..* BackboneElement Who or what is in group
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic:HasSDOHCondition.​code Base example Not State Unknown
Group.characteristic:HasSDOHCondition.​value[x] Base extensible SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Group.characteristic:HasPayer.​code Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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)

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group Group of SDOH patients for a payer
Group.active 1..1 boolean Whether this group's record is in active use
Fixed Value: true (no extensions allowed)
Group.type 1..1 code person
Fixed Value: person (no extensions allowed)
Group.actual 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
Group.Slices for characteristic.characteristic:HasSDOHCondition This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasSDOHCondition.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "sdoh-condition-category"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasSDOHCondition.value[x] This element must be supported. 1..1 CodeableConcept Value held by characteristic
Binding: SDOHCC ValueSet SDOH Category (extensible)
Group.Slices for characteristic.characteristic:HasSDOHCondition.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.Slices for characteristic.characteristic:HasSDOHCondition.period 0..0 Period over which characteristic is tested
Group.Slices for characteristic.characteristic:HasPayer This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasPayer.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "payer-coverage"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasPayer.value[x] This element must be supported. 1..1 Reference(US Core Organization Profile(7.0.0)) Value held by characteristic
Group.Slices for characteristic.characteristic:HasPayer.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.Slices for characteristic.characteristic:HasPayer.period 0..0 Period over which characteristic is tested
Group.member This element must be supported. 0..* BackboneElement Who or what is in group
Group.member.entity This element must be supported. 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.characteristic:HasSDOHCondition.​value[x] Base extensible SDOHCC ValueSet SDOH Category 📦3.1.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* Group Group of SDOH patients for a payer
Constraints: grp-1
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Group.text 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
Group.contained 0..* Resource Contained, inline Resources
Group.extension 0..* Extension Additional content defined by implementations
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.identifier This element is included in summaries. 0..* Identifier Unique id
Group.active This element is included in summaries. 1..1 boolean Whether this group's record is in active use
Fixed Value: true (no extensions allowed)
Group.type This element is included in summaries. 1..1 code person
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person (no extensions allowed)
Group.actual This element is included in summaries. C 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.code This element is included in summaries. 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
Group.name This element is included in summaries. 0..1 string Label for Group
Group.quantity This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element is included in summaries. 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
Group.Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
Group.Slices for characteristic.characteristic:All Slices Content/Rules for all slices
Group.Slices for characteristic.characteristic:All Slices.id 0..1 string Unique id for inter-element referencing
Group.Slices for characteristic.characteristic:All Slices.extension 0..* Extension Additional content defined by implementations
Group.Slices for characteristic.characteristic:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:All Slices.code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Group.Slices for characteristic.characteristic:All Slices.value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
Group.Slices for characteristic.characteristic:All Slices.value[x].valueCodeableConcept CodeableConcept
Group.Slices for characteristic.characteristic:All Slices.value[x].valueBoolean boolean
Group.Slices for characteristic.characteristic:All Slices.value[x].valueQuantity Quantity
Group.Slices for characteristic.characteristic:All Slices.value[x].valueRange Range
Group.Slices for characteristic.characteristic:All Slices.value[x].valueReference Reference(Any)
Group.Slices for characteristic.characteristic:All Slices.exclude 1..1 boolean Group includes or excludes
Group.Slices for characteristic.characteristic:All Slices.period 0..1 Period Period over which characteristic is tested
Group.Slices for characteristic.characteristic:HasSDOHCondition This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasSDOHCondition.id 0..1 string Unique id for inter-element referencing
Group.Slices for characteristic.characteristic:HasSDOHCondition.extension 0..* Extension Additional content defined by implementations
Group.Slices for characteristic.characteristic:HasSDOHCondition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:HasSDOHCondition.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "sdoh-condition-category"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasSDOHCondition.value[x] This element must be supported. 1..1 CodeableConcept Value held by characteristic
Binding: SDOHCC ValueSet SDOH Category (extensible)
Group.Slices for characteristic.characteristic:HasSDOHCondition.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.Slices for characteristic.characteristic:HasPayer This element must be supported. 1..1 BackboneElement Include / Exclude group members by Trait
Group.Slices for characteristic.characteristic:HasPayer.id 0..1 string Unique id for inter-element referencing
Group.Slices for characteristic.characteristic:HasPayer.extension 0..* Extension Additional content defined by implementations
Group.Slices for characteristic.characteristic:HasPayer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.Slices for characteristic.characteristic:HasPayer.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes",
      "code" : "payer-coverage"
    }
  ]
}
Group.Slices for characteristic.characteristic:HasPayer.value[x] This element must be supported. 1..1 Reference(US Core Organization Profile(7.0.0)) Value held by characteristic
Group.Slices for characteristic.characteristic:HasPayer.exclude This element must be supported. 1..1 boolean Group includes or excludes
Fixed Value: false (no extensions allowed)
Group.member This element must be supported. C 0..* BackboneElement Who or what is in group
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.extension 0..* Extension Additional content defined by implementations
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
Group.member.period 0..1 Period Period member belonged to the group
Group.member.inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic:HasSDOHCondition.​code Base example Not State Unknown
Group.characteristic:HasSDOHCondition.​value[x] Base extensible SDOHCC ValueSet SDOH Category 📦3.1.0 This IG
Group.characteristic:HasPayer.​code Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
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)

This structure is derived from Group

Summary

Mandatory: 3 elements
Must-Support: 10 elements
Fixed: 5 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Group.characteristic

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron