CARIN Digital Insurance Card
0.1.0 - STU 1 Ballot

This page is part of the CARIN Digital Insurance Card (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Extension: Plan Beneficiaries

This extension allows for the representation of all of the members on the plan with corresponding Names and MemberIDs. This enables health plans to pass this information along with the Coverage resources to align with how this content is printed on physical insurance cards.

The official URL for this extension is: 

http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-PlanBeneficiaries-extension

Status: active
Extension maintained by: HL7 Payer/Provider Information Exchange Working Group (PIE WG)

Context of Use

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

  • Coverage

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

Mandatory: 6 elements
Must-Support: 4 elements
Fixed Value: 3 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPlan Beneficiaries
... extension 2..*ExtensionExtension
... extension:memberId S1..1ExtensionMember Id
.... extension 0..0
.... url 1..1uri"memberId"
.... value[x] 1..1stringValue of extension
... extension:name S1..1ExtensionMember Name
.... extension 0..0
.... url 1..1uri"name"
.... Slices for value[x] 1..1HumanNameValue of extension
Slice: Unordered, Open by type:$this
.... valueHumanName 1..1HumanNameValue of extension
..... family S1..1stringFamily name (often called 'Surname')
..... given S0..*stringGiven names (not always 'first'). Includes middle names
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPlan Beneficiaries
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:memberId S1..1ExtensionMember Id
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"memberId"
.... value[x] 1..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"name"
.... Slices for value[x] 1..1HumanNameValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueHumanName 1..1HumanNameValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... text Σ0..1stringText representation of the full name
...... family SΣ1..1stringFamily name (often called 'Surname')
...... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
...... period Σ0..1PeriodTime period when name was/is in use
... url 1..1uri"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-PlanBeneficiaries-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 6 elements
Must-Support: 4 elements
Fixed Value: 3 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPlan Beneficiaries
... extension 2..*ExtensionExtension
... extension:memberId S1..1ExtensionMember Id
.... extension 0..0
.... url 1..1uri"memberId"
.... value[x] 1..1stringValue of extension
... extension:name S1..1ExtensionMember Name
.... extension 0..0
.... url 1..1uri"name"
.... Slices for value[x] 1..1HumanNameValue of extension
Slice: Unordered, Open by type:$this
.... valueHumanName 1..1HumanNameValue of extension
..... family S1..1stringFamily name (often called 'Surname')
..... given S0..*stringGiven names (not always 'first'). Includes middle names
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPlan Beneficiaries
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:memberId S1..1ExtensionMember Id
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"memberId"
.... value[x] 1..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"name"
.... Slices for value[x] 1..1HumanNameValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueHumanName 1..1HumanNameValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... text Σ0..1stringText representation of the full name
...... family SΣ1..1stringFamily name (often called 'Surname')
...... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
...... period Σ0..1PeriodTime period when name was/is in use
... url 1..1uri"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-PlanBeneficiaries-extension"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:name.value[x]:valueHumanName.userequiredNameUse