SDOH Clinical Care
2.1.0 - STU 2.1 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 2.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: 2.1.0
Standards status: Trial-use 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.

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.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of SDOH patients for a payer
... active 1..1booleanWhether this group's record is in active use
Fixed Value: true
... type 1..1codeperson
Fixed Value: person
... actual 1..1booleanDescriptive or actual
Fixed Value: true
.... characteristic:HasSDOHCondition S1..1BackboneElementInclude / Exclude group members by Trait
..... code S1..1CodeableConceptKind of characteristic
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh-condition-category
..... value[x] S1..1Reference(ValueSet)Value held by characteristic
Required Pattern: At least the following
...... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
..... period 0..0
.... characteristic:HasPayer S1..1BackboneElementInclude / Exclude group members by Trait
..... code S1..1CodeableConceptKind of characteristic
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: payer-coverage
..... value[x] S1..1Reference(US Core Organization Profile)Value held by characteristic
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
..... period 0..0
... member S0..*BackboneElementWho or what is in group
.... entity S1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of SDOH patients for a payer
grp-1: Can only have members if group is "actual"
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active Σ1..1booleanWhether this group's record is in active use
Fixed Value: true
... actual ΣC1..1booleanDescriptive or actual
Fixed Value: true
... Slices for characteristic 2..*BackboneElementInclude / Exclude group members by Trait
Slice: Unordered, Open by pattern:code
.... characteristic:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

..... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

...... valueCodeableConceptCodeableConcept
...... valueBooleanboolean
...... valueQuantityQuantity
...... valueRangeRange
...... valueReferenceReference(Any)
..... exclude 1..1booleanGroup includes or excludes
.... characteristic:HasSDOHCondition S1..1BackboneElementInclude / Exclude group members by Trait
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptKind 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh-condition-category
..... value[x] S1..1Reference(ValueSet)Value held by characteristic
Required Pattern: At least the following
...... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
.... characteristic:HasPayer S1..1BackboneElementInclude / Exclude group members by Trait
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptKind 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: payer-coverage
..... value[x] S1..1Reference(US Core Organization Profile)Value held by characteristic
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
... member SC0..*BackboneElementWho or what is in group
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.characteristic:HasSDOHCondition.codeexamplePattern: sdoh-condition-category
Group.characteristic:HasPayer.codeexamplePattern: payer-coverage

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of SDOH patients for a payer
grp-1: Can only have members if group is "actual"
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique id
... active Σ1..1booleanWhether this group's record is in active use
Fixed Value: true
... type Σ1..1codeperson
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual ΣC1..1booleanDescriptive or actual
Fixed Value: true
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... Slices for characteristic 2..*BackboneElementInclude / Exclude group members by Trait
Slice: Unordered, Open by pattern:code
.... characteristic:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

..... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

...... valueCodeableConceptCodeableConcept
...... valueBooleanboolean
...... valueQuantityQuantity
...... valueRangeRange
...... valueReferenceReference(Any)
..... exclude 1..1booleanGroup includes or excludes
..... period 0..1PeriodPeriod over which characteristic is tested
.... characteristic:HasSDOHCondition S1..1BackboneElementInclude / Exclude group members by Trait
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptKind 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh-condition-category
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] S1..1Reference(ValueSet)Value held by characteristic
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
...... type0..1uriType the reference refers to (e.g. "Patient")
...... identifier0..1IdentifierLogical reference, when literal reference is not known
...... display0..1stringText alternative for the resource
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
.... characteristic:HasPayer S1..1BackboneElementInclude / Exclude group members by Trait
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptKind 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: payer-coverage
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] S1..1Reference(US Core Organization Profile)Value held by characteristic
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
... member SC0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member
.... period 0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.characteristic:HasSDOHCondition.codeexamplePattern: sdoh-condition-category
Group.characteristic:HasPayer.codeexamplePattern: payer-coverage

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan 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 Value: 5 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Group.characteristic is sliced based on the value of pattern:code

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of SDOH patients for a payer
... active 1..1booleanWhether this group's record is in active use
Fixed Value: true
... type 1..1codeperson
Fixed Value: person
... actual 1..1booleanDescriptive or actual
Fixed Value: true
.... characteristic:HasSDOHCondition S1..1BackboneElementInclude / Exclude group members by Trait
..... code S1..1CodeableConceptKind of characteristic
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh-condition-category
..... value[x] S1..1Reference(ValueSet)Value held by characteristic
Required Pattern: At least the following
...... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
..... period 0..0
.... characteristic:HasPayer S1..1BackboneElementInclude / Exclude group members by Trait
..... code S1..1CodeableConceptKind of characteristic
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: payer-coverage
..... value[x] S1..1Reference(US Core Organization Profile)Value held by characteristic
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
..... period 0..0
... member S0..*BackboneElementWho or what is in group
.... entity S1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of SDOH patients for a payer
grp-1: Can only have members if group is "actual"
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active Σ1..1booleanWhether this group's record is in active use
Fixed Value: true
... actual ΣC1..1booleanDescriptive or actual
Fixed Value: true
... Slices for characteristic 2..*BackboneElementInclude / Exclude group members by Trait
Slice: Unordered, Open by pattern:code
.... characteristic:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

..... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

...... valueCodeableConceptCodeableConcept
...... valueBooleanboolean
...... valueQuantityQuantity
...... valueRangeRange
...... valueReferenceReference(Any)
..... exclude 1..1booleanGroup includes or excludes
.... characteristic:HasSDOHCondition S1..1BackboneElementInclude / Exclude group members by Trait
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptKind 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh-condition-category
..... value[x] S1..1Reference(ValueSet)Value held by characteristic
Required Pattern: At least the following
...... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
.... characteristic:HasPayer S1..1BackboneElementInclude / Exclude group members by Trait
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptKind 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: payer-coverage
..... value[x] S1..1Reference(US Core Organization Profile)Value held by characteristic
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
... member SC0..*BackboneElementWho or what is in group
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.characteristic:HasSDOHCondition.codeexamplePattern: sdoh-condition-category
Group.characteristic:HasPayer.codeexamplePattern: payer-coverage

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of SDOH patients for a payer
grp-1: Can only have members if group is "actual"
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique id
... active Σ1..1booleanWhether this group's record is in active use
Fixed Value: true
... type Σ1..1codeperson
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual ΣC1..1booleanDescriptive or actual
Fixed Value: true
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... Slices for characteristic 2..*BackboneElementInclude / Exclude group members by Trait
Slice: Unordered, Open by pattern:code
.... characteristic:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

..... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

...... valueCodeableConceptCodeableConcept
...... valueBooleanboolean
...... valueQuantityQuantity
...... valueRangeRange
...... valueReferenceReference(Any)
..... exclude 1..1booleanGroup includes or excludes
..... period 0..1PeriodPeriod over which characteristic is tested
.... characteristic:HasSDOHCondition S1..1BackboneElementInclude / Exclude group members by Trait
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptKind 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: sdoh-condition-category
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] S1..1Reference(ValueSet)Value held by characteristic
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... reference1..1stringLiteral reference, Relative, internal or absolute URL
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
...... type0..1uriType the reference refers to (e.g. "Patient")
...... identifier0..1IdentifierLogical reference, when literal reference is not known
...... display0..1stringText alternative for the resource
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
.... characteristic:HasPayer S1..1BackboneElementInclude / Exclude group members by Trait
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptKind 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: payer-coverage
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] S1..1Reference(US Core Organization Profile)Value held by characteristic
..... exclude S1..1booleanGroup includes or excludes
Fixed Value: false
... member SC0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member
.... period 0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.characteristic:HasSDOHCondition.codeexamplePattern: sdoh-condition-category
Group.characteristic:HasPayer.codeexamplePattern: payer-coverage

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan 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 Value: 5 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Group.characteristic is sliced based on the value of pattern:code

 

Other representations of profile: CSV, Excel, Schematron