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

Extension: FHIRMembership

Official URL: http://hl7.org/fhir/us/StructureDefinition/FHIRmembership Version: 0.1.0
Draft as of 2024-03-07 Computable Name: FHIRMembership

Membership

Context of Use

This extension may be used on the following element(s):

  • Element ID Element

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: Membership

  • individual: Reference: An Extension
  • membership: CodeableConcept: An Extension
  • effectiveTime: Period: An Extension
  • status: CodeableConcept: An Extension
  • role: CodeableConcept: An Extension
  • verification: CodeableConcept: An Extension

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 1..*ExtensionExtension
... extension:individual S1..1ExtensionIndividual who requires service(s)
.... extension 0..0
.... url 1..1uri"individual"
.... value[x] 0..1Reference(FHIR Realization Model for EFSS : IndividualRole | Patient)Value of extension
... extension:membership S0..1ExtensionType of membership, HUD household for instance
.... extension 0..0
.... url 1..1uri"membership"
.... value[x] 0..1CodeableConceptValue of extension
.... extension 0..0
.... url 1..1uri"effectiveTime"
.... value[x] 0..1PeriodValue of extension
... extension:status S0..1Extensionstatus
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
... extension:role S0..1ExtensionPossible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household
.... extension 0..0
.... url 1..1uri"role"
.... value[x] 0..1CodeableConceptValue of extension
... extension:verification S0..1ExtensionVerification status of the membership/eligbility of this individual in set
.... extension 0..0
.... url 1..1uri"verification"
.... value[x] 0..1CodeableConceptValue of extension
... url 1..1uri"http://hl7.org/fhir/us/StructureDefinition/FHIRmembership"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:individual S1..1ExtensionIndividual who requires service(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"individual"
.... value[x] 0..1Reference(FHIR Realization Model for EFSS : IndividualRole | Patient)Value of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"membership"
.... value[x] 0..1CodeableConceptValue of extension
... extension:effectiveTime S0..1ExtensionWhen the membership was active
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"effectiveTime"
.... value[x] 0..1PeriodValue of extension
... extension:status S0..1Extensionstatus
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
... extension:role S0..1ExtensionPossible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"role"
.... value[x] 0..1CodeableConceptValue of extension
... extension:verification S0..1ExtensionVerification status of the membership/eligbility of this individual in set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"verification"
.... value[x] 0..1CodeableConceptValue of extension
... url 1..1uri"http://hl7.org/fhir/us/StructureDefinition/FHIRmembership"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Membership

  • individual: Reference: An Extension
  • membership: CodeableConcept: An Extension
  • effectiveTime: Period: An Extension
  • status: CodeableConcept: An Extension
  • role: CodeableConcept: An Extension
  • verification: CodeableConcept: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 1..*ExtensionExtension
... extension:individual S1..1ExtensionIndividual who requires service(s)
.... extension 0..0
.... url 1..1uri"individual"
.... value[x] 0..1Reference(FHIR Realization Model for EFSS : IndividualRole | Patient)Value of extension
... extension:membership S0..1ExtensionType of membership, HUD household for instance
.... extension 0..0
.... url 1..1uri"membership"
.... value[x] 0..1CodeableConceptValue of extension
.... extension 0..0
.... url 1..1uri"effectiveTime"
.... value[x] 0..1PeriodValue of extension
... extension:status S0..1Extensionstatus
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
... extension:role S0..1ExtensionPossible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household
.... extension 0..0
.... url 1..1uri"role"
.... value[x] 0..1CodeableConceptValue of extension
... extension:verification S0..1ExtensionVerification status of the membership/eligbility of this individual in set
.... extension 0..0
.... url 1..1uri"verification"
.... value[x] 0..1CodeableConceptValue of extension
... url 1..1uri"http://hl7.org/fhir/us/StructureDefinition/FHIRmembership"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:individual S1..1ExtensionIndividual who requires service(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"individual"
.... value[x] 0..1Reference(FHIR Realization Model for EFSS : IndividualRole | Patient)Value of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"membership"
.... value[x] 0..1CodeableConceptValue of extension
... extension:effectiveTime S0..1ExtensionWhen the membership was active
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"effectiveTime"
.... value[x] 0..1PeriodValue of extension
... extension:status S0..1Extensionstatus
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
... extension:role S0..1ExtensionPossible role person is as part as it pertains to the type of membershihp, Head of Household for HUD Household
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"role"
.... value[x] 0..1CodeableConceptValue of extension
... extension:verification S0..1ExtensionVerification status of the membership/eligbility of this individual in set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"verification"
.... value[x] 0..1CodeableConceptValue of extension
... url 1..1uri"http://hl7.org/fhir/us/StructureDefinition/FHIRmembership"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
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()