Enhancing FHIR for Social Services
0.1.0 - ci-build
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
| Draft as of 2024-03-07 |
Definitions for the membership data type profile.
Guidance on how to interpret the contents of this table can be found here
| 0. membership | |
| Definition | Membership |
| Short | FHIR Analysis Model for EFSS : Membership |
| Invariants | membership-1: Effective Time has start date (effectiveTime.start.exists()) |
| 2. membership.individual | |
| Definition | Individual |
| Short | Individual who requires service(s) |
| Control | 1..1 |
| Type | DomainResource(FHIR Analysis Model for EFSS : Individual) |
| 4. membership.membership | |
| Definition | Membership |
| Short | Type of membership, HUD household for instance |
| Control | 0..1 |
| Binding | For example codes, see Membership Type Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-type-code-vs) |
| Type | CodeableConcept |
| 6. membership.effectiveTime | |
| Definition | Effective Time |
| Short | When the membership was active |
| Control | 1..1 |
| Type | Period |
| 8. membership.status | |
| Definition | Status |
| Short | status |
| Control | 0..* |
| Binding | For example codes, see Membership Status Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-status-role-vs) |
| Type | CodeableConcept |
| 10. membership.role | |
| Definition | Status |
| Short | Possible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household |
| Control | 0..* |
| Binding | For example codes, see Membership Role Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-type-role-vs) |
| Type | CodeableConcept |
| 12. membership.verification | |
| Definition | Verification |
| Short | Verification status of the membership/eligbility of this individual in set |
| Control | 0..* |
| Binding | For example codes, see Membership Verification Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-verification-role-vs) |
| Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be found here
| 0. membership | |
| Definition | Membership Base definition for all elements in a resource. |
| Short | FHIR Analysis Model for EFSS : MembershipBase for all elements |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))membership-1: Effective Time has start date ( effectiveTime.start.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. membership.individual | |
| Definition | Individual |
| Short | Individual who requires service(s) |
| Control | 1..1 |
| Type | DomainResource(FHIR Analysis Model for EFSS : Individual) |
| Summary | true |
| 4. membership.membership | |
| Definition | Membership |
| Short | Type of membership, HUD household for instance |
| Control | 0..1 |
| Binding | For example codes, see Membership Type Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-type-code-vs) |
| Type | CodeableConcept |
| Summary | true |
| 6. membership.effectiveTime | |
| Definition | Effective Time |
| Short | When the membership was active |
| Control | 1..1 |
| Type | Period |
| Summary | true |
| 8. membership.status | |
| Definition | Status |
| Short | status |
| Control | 0..* |
| Binding | For example codes, see Membership Status Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-status-role-vs) |
| Type | CodeableConcept |
| Summary | true |
| 10. membership.role | |
| Definition | Status |
| Short | Possible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household |
| Control | 0..* |
| Binding | For example codes, see Membership Role Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-type-role-vs) |
| Type | CodeableConcept |
| Summary | true |
| 12. membership.verification | |
| Definition | Verification |
| Short | Verification status of the membership/eligbility of this individual in set |
| Control | 0..* |
| Binding | For example codes, see Membership Verification Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-verification-role-vs) |
| Type | CodeableConcept |
| Summary | true |
Guidance on how to interpret the contents of this table can be found here
| 0. membership | |
| Definition | Membership |
| Short | FHIR Analysis Model for EFSS : Membership |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))membership-1: Effective Time has start date ( effectiveTime.start.exists()) |
| 2. membership.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. membership.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on membership.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 6. membership.individual | |
| Definition | Individual |
| Short | Individual who requires service(s) |
| Control | 1..1 |
| Type | DomainResource(FHIR Analysis Model for EFSS : Individual) |
| Summary | true |
| 8. membership.membership | |
| Definition | Membership |
| Short | Type of membership, HUD household for instance |
| Control | 0..1 |
| Binding | For example codes, see Membership Type Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-type-code-vs) |
| Type | CodeableConcept |
| Summary | true |
| 10. membership.effectiveTime | |
| Definition | Effective Time |
| Short | When the membership was active |
| Control | 1..1 |
| Type | Period |
| Summary | true |
| 12. membership.status | |
| Definition | Status |
| Short | status |
| Control | 0..* |
| Binding | For example codes, see Membership Status Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-status-role-vs) |
| Type | CodeableConcept |
| Summary | true |
| 14. membership.role | |
| Definition | Status |
| Short | Possible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household |
| Control | 0..* |
| Binding | For example codes, see Membership Role Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-type-role-vs) |
| Type | CodeableConcept |
| Summary | true |
| 16. membership.verification | |
| Definition | Verification |
| Short | Verification status of the membership/eligbility of this individual in set |
| Control | 0..* |
| Binding | For example codes, see Membership Verification Code VS (example to http://hl7.org/fhir/us/ValueSet/membership-verification-role-vs) |
| Type | CodeableConcept |
| Summary | true |