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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: FHIR Analysis Model for EFSS : Membership

Membership

Usage:

• This DataType 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.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Element

Name	Flags	Card.	Type	Description & Constraints
membership	C	0..*	Element	FHIR Analysis Model for EFSS : Membership membership-1: Effective Time has start date
individual	Σ	1..1	Individual	Individual who requires service(s)
membership	Σ	0..1	CodeableConcept	Type of membership, HUD household for instance Binding: Membership Type Code VS (example)
effectiveTime	Σ	1..1	Period	When the membership was active
status	Σ	0..*	CodeableConcept	status Binding: Membership Status Code VS (example)
role	Σ	0..*	CodeableConcept	Possible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household Binding: Membership Role Code VS (example)
verification	Σ	0..*	CodeableConcept	Verification status of the membership/eligbility of this individual in set Binding: Membership Verification Code VS (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
membership.membership	example	MembershipTypeCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-code-vs from this IG
membership.status	example	MembershipStatusCodeVS http://hl7.org/fhir/us/ValueSet/membership-status-role-vs from this IG
membership.role	example	MembershipRoleCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-role-vs from this IG
membership.verification	example	MembershipVerificationCodeVS http://hl7.org/fhir/us/ValueSet/membership-verification-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
membership-1	error	membership	Effective Time has start date : effectiveTime.start.exists()

Name	Flags	Card.	Type	Description & Constraints
membership	C	0..*	Element	FHIR Analysis Model for EFSS : Membership membership-1: Effective Time has start date
individual	Σ	1..1	Individual	Individual who requires service(s)
membership	Σ	0..1	CodeableConcept	Type of membership, HUD household for instance Binding: Membership Type Code VS (example)
effectiveTime	Σ	1..1	Period	When the membership was active
status	Σ	0..*	CodeableConcept	status Binding: Membership Status Code VS (example)
role	Σ	0..*	CodeableConcept	Possible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household Binding: Membership Role Code VS (example)
verification	Σ	0..*	CodeableConcept	Verification status of the membership/eligbility of this individual in set Binding: Membership Verification Code VS (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
membership.membership	example	MembershipTypeCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-code-vs from this IG
membership.status	example	MembershipStatusCodeVS http://hl7.org/fhir/us/ValueSet/membership-status-role-vs from this IG
membership.role	example	MembershipRoleCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-role-vs from this IG
membership.verification	example	MembershipVerificationCodeVS http://hl7.org/fhir/us/ValueSet/membership-verification-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
membership-1	error	membership	Effective Time has start date : effectiveTime.start.exists()

Name	Flags	Card.	Type	Description & Constraints
membership	C	0..*	Element	FHIR Analysis Model for EFSS : Membership membership-1: Effective Time has start date
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
individual	Σ	1..1	Individual	Individual who requires service(s)
membership	Σ	0..1	CodeableConcept	Type of membership, HUD household for instance Binding: Membership Type Code VS (example)
effectiveTime	Σ	1..1	Period	When the membership was active
status	Σ	0..*	CodeableConcept	status Binding: Membership Status Code VS (example)
role	Σ	0..*	CodeableConcept	Possible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household Binding: Membership Role Code VS (example)
verification	Σ	0..*	CodeableConcept	Verification status of the membership/eligbility of this individual in set Binding: Membership Verification Code VS (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
membership.membership	example	MembershipTypeCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-code-vs from this IG
membership.status	example	MembershipStatusCodeVS http://hl7.org/fhir/us/ValueSet/membership-status-role-vs from this IG
membership.role	example	MembershipRoleCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-role-vs from this IG
membership.verification	example	MembershipVerificationCodeVS http://hl7.org/fhir/us/ValueSet/membership-verification-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
membership-1	error	membership	Effective Time has start date : effectiveTime.start.exists()

This structure is derived from Element

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

• FHIR Analysis Model for EFSS : Individual (http://hl7.org/fhir/us/StructureDefinition/Individual)

Differential View

This structure is derived from Element

Name	Flags	Card.	Type	Description & Constraints
membership	C	0..*	Element	FHIR Analysis Model for EFSS : Membership membership-1: Effective Time has start date
individual	Σ	1..1	Individual	Individual who requires service(s)
membership	Σ	0..1	CodeableConcept	Type of membership, HUD household for instance Binding: Membership Type Code VS (example)
effectiveTime	Σ	1..1	Period	When the membership was active
status	Σ	0..*	CodeableConcept	status Binding: Membership Status Code VS (example)
role	Σ	0..*	CodeableConcept	Possible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household Binding: Membership Role Code VS (example)
verification	Σ	0..*	CodeableConcept	Verification status of the membership/eligbility of this individual in set Binding: Membership Verification Code VS (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
membership.membership	example	MembershipTypeCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-code-vs from this IG
membership.status	example	MembershipStatusCodeVS http://hl7.org/fhir/us/ValueSet/membership-status-role-vs from this IG
membership.role	example	MembershipRoleCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-role-vs from this IG
membership.verification	example	MembershipVerificationCodeVS http://hl7.org/fhir/us/ValueSet/membership-verification-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
membership-1	error	membership	Effective Time has start date : effectiveTime.start.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
membership	C	0..*	Element	FHIR Analysis Model for EFSS : Membership membership-1: Effective Time has start date
individual	Σ	1..1	Individual	Individual who requires service(s)
membership	Σ	0..1	CodeableConcept	Type of membership, HUD household for instance Binding: Membership Type Code VS (example)
effectiveTime	Σ	1..1	Period	When the membership was active
status	Σ	0..*	CodeableConcept	status Binding: Membership Status Code VS (example)
role	Σ	0..*	CodeableConcept	Possible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household Binding: Membership Role Code VS (example)
verification	Σ	0..*	CodeableConcept	Verification status of the membership/eligbility of this individual in set Binding: Membership Verification Code VS (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
membership.membership	example	MembershipTypeCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-code-vs from this IG
membership.status	example	MembershipStatusCodeVS http://hl7.org/fhir/us/ValueSet/membership-status-role-vs from this IG
membership.role	example	MembershipRoleCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-role-vs from this IG
membership.verification	example	MembershipVerificationCodeVS http://hl7.org/fhir/us/ValueSet/membership-verification-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
membership-1	error	membership	Effective Time has start date : effectiveTime.start.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
membership	C	0..*	Element	FHIR Analysis Model for EFSS : Membership membership-1: Effective Time has start date
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
individual	Σ	1..1	Individual	Individual who requires service(s)
membership	Σ	0..1	CodeableConcept	Type of membership, HUD household for instance Binding: Membership Type Code VS (example)
effectiveTime	Σ	1..1	Period	When the membership was active
status	Σ	0..*	CodeableConcept	status Binding: Membership Status Code VS (example)
role	Σ	0..*	CodeableConcept	Possible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household Binding: Membership Role Code VS (example)
verification	Σ	0..*	CodeableConcept	Verification status of the membership/eligbility of this individual in set Binding: Membership Verification Code VS (example)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
membership.membership	example	MembershipTypeCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-code-vs from this IG
membership.status	example	MembershipStatusCodeVS http://hl7.org/fhir/us/ValueSet/membership-status-role-vs from this IG
membership.role	example	MembershipRoleCodeVS http://hl7.org/fhir/us/ValueSet/membership-type-role-vs from this IG
membership.verification	example	MembershipVerificationCodeVS http://hl7.org/fhir/us/ValueSet/membership-verification-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
membership-1	error	membership	Effective Time has start date : effectiveTime.start.exists()

This structure is derived from Element

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

• FHIR Analysis Model for EFSS : Individual (http://hl7.org/fhir/us/StructureDefinition/Individual)

Other representations of profile: CSV, Excel, Schematron