Enhancing FHIR for Social Services, published by SDOH. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/efss/ and changes regularly. See the Directory of published versions
Resource Profile: FHIR Realization Model for EFSS : Life Set
| Official URL: http://hl7.org/fhir/us/StructureDefinition/FHIRLifeSet | Version: 0.1.0 | |||
| Draft as of 2024-03-07 | Computable Name: FHIRLifeSet | |||
Life Set is an amalgamation of the persons/groups who constitute the interactions and relationships from the perspectice of an individual. The associations from the individual to the person/group are explicit in nature as to avoid confusion and structured to properly elaborate all aspects of the particular association
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
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 | Group of multiple entities | |
  Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 subject | S | 1..1 | Reference(FHIR Realization Model for EFSS : IndividualRole | Patient) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirsubject |
| assssociation | S | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirassssociation |
 characteristic | 0..0 | |||
 member | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| subject | S | 1..1 | Reference(FHIR Realization Model for EFSS : IndividualRole | Patient) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirsubject |
| assssociation | S | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirassssociation |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. |
| actual | ΣC | 1..1 | boolean | Descriptive or actual |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | |
| Group.characteristic.code | example | ||
| Group.characteristic.value[x] | example |
Constraints
| 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 | Group of multiple entities grp-1: Can only have members if group is "actual" | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| subject | S | 1..1 | Reference(FHIR Realization Model for EFSS : IndividualRole | Patient) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirsubject | ||||
| assssociation | S | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirassssociation | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique id | ||||
| active | Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. | ||||
| actual | ΣC | 1..1 | boolean | Descriptive or actual | ||||
| 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 | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
Constraints
| 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) |
This structure is derived from Group
Differential View
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | 0..* | Group | Group of multiple entities | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| subject | S | 1..1 | Reference(FHIR Realization Model for EFSS : IndividualRole | Patient) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirsubject |
| assssociation | S | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirassssociation |
| characteristic | 0..0 | |||
| member | 0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| subject | S | 1..1 | Reference(FHIR Realization Model for EFSS : IndividualRole | Patient) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirsubject |
| assssociation | S | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirassssociation |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. |
| actual | ΣC | 1..1 | boolean | Descriptive or actual |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | |
| Group.characteristic.code | example | ||
| Group.characteristic.value[x] | example |
Constraints
| 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 | Group of multiple entities grp-1: Can only have members if group is "actual" | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| subject | S | 1..1 | Reference(FHIR Realization Model for EFSS : IndividualRole | Patient) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirsubject | ||||
| assssociation | S | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/us/StructureDefinition/fhirassssociation | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique id | ||||
| active | Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. | ||||
| actual | ΣC | 1..1 | boolean | Descriptive or actual | ||||
| 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 | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
Constraints
| 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) |
This structure is derived from Group
Other representations of profile: CSV, Excel, Schematron