CARIN Digital Insurance Card
0.1.0 - STU 1 Ballot
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 
Definitions for the C4DIC-PlanBeneficiaries-extension extension.
| 1. Extension | |
| Definition | 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. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element 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()) |
| 2. Extension.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 3. Extension.extension | |
| Definition | An Extension |
| Control | 2..* |
| Type | Extension |
| Invariants | Defined on this element 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 Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Extension.extension:memberId | |
| SliceName | memberId |
| Definition | An Extension |
| Control | 1..1 |
| Type | Extension |
| Must Support | true |
| Invariants | Defined on this element 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()) |
| 5. Extension.extension:memberId.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 6. Extension.extension:memberId.extension | |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Invariants | Defined on this element 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 Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 7. Extension.extension:memberId.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | memberId |
| 8. Extension.extension:memberId.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 1..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. Extension.extension:name | |
| SliceName | name |
| Definition | An Extension |
| Control | 1..1 |
| Type | Extension |
| Must Support | true |
| Invariants | Defined on this element 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()) |
| 10. Extension.extension:name.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 11. Extension.extension:name.extension | |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Invariants | Defined on this element 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 Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 12. Extension.extension:name.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | name |
| 13. Extension.extension:name.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 1..1 |
| Type | HumanName |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
| 14. Extension.extension:name.value[x]:valueHumanName | |
| SliceName | valueHumanName |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 1..1 |
| Type | HumanName |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 15. Extension.extension:name.value[x]:valueHumanName.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 16. Extension.extension:name.value[x]:valueHumanName.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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element 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 Extension.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 17. Extension.extension:name.value[x]:valueHumanName.use | |
| Definition | Identifies the purpose for this name. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NameUse The use of a human name. |
| Type | code |
| Is Modifier | true |
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 18. Extension.extension:name.value[x]:valueHumanName.text | |
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. |
| Control | 0..1 |
| Type | string |
| Requirements | A renderable, unencoded form. |
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 19. Extension.extension:name.value[x]:valueHumanName.family | |
| Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
| Control | 1..1 |
| Type | string |
| Must Support | true |
| Alternate Names | surname |
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 20. Extension.extension:name.value[x]:valueHumanName.given | |
| Definition | Given name. |
| Control | 0..* |
| Type | string |
| Must Support | true |
| Alternate Names | first name, middle name |
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 21. Extension.extension:name.value[x]:valueHumanName.prefix | |
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. |
| Control | 0..* |
| Type | string |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 22. Extension.extension:name.value[x]:valueHumanName.suffix | |
| Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
| Control | 0..* |
| Type | string |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 23. Extension.extension:name.value[x]:valueHumanName.period | |
| Definition | Indicates the period of time when this name was valid for the named person. |
| Control | 0..1 |
| Type | Period |
| Requirements | Allows names to be placed in historical context. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 24. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-PlanBeneficiaries-extension |
| 25. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
IG © 2021+ HL7 Payer/Provider Information Exchange Working Group (PIE WG). Package hl7.fhir.us.insurance-card#0.1.0 based on FHIR 4.0.1. Generated 2021-12-06
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change