Da Vinci Payer Data Exchange
2.2.1 - STU 2.2 United States of America flag

Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions

Resource Profile: Member Opt-Out Group

Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-member-opt-out Version: 2.2.1
Standards status: Trial-use Maturity Level: 2 Computable Name: MemberOptOut
Other Identifiers: OID:2.16.840.1.113883.4.642.40.8.42.43

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

A Group resource representing members who have opted out of Provider Access API data sharing. Intended use: this profile is offered as a payer-internal FHIR-based scaffolding pattern that implementers MAY adopt when their existing platform (legacy system, vendor product, internal API) cannot itself act as the authoritative reference source for opt-out determinations. Implementers whose existing systems can answer opt-out queries authoritatively are not required to use this profile. Secondary use: the same profile serves as the wire-format target profile for the ConsentConstrainedMembers output of the $provider-member-match operation; a ConsentConstrainedMembers Group returned by that operation conforms to this profile regardless of the mechanism the payer uses internally to determine opt-out status. Privacy default — SHOULD suppress when opt-out status is sensitive. Where a payer determines that disclosing opt-out status to a requesting provider would itself constitute a disclosure the member did not authorize (whether under applicable state privacy law, the member's stated preference, or the payer's privacy policy), the payer SHOULD suppress the ConsentConstrainedMembers output of $provider-member-match and instead include the affected members in the NonMatchedMembers Group; this makes the response indistinguishable to the requester between a true no-match and a matched-but-opted-out outcome. The internal-tracking use of this profile is unaffected by that choice. Distinguishing master-list instances from operation-emitted response instances. Both the payer-internal master opt-out list and the response Group emitted by $provider-member-match conform to this profile, so a payer storing both must distinguish them at query time. The recommended discriminator is Group.identifier: the payer SHOULD assign master-list instances a Group.identifier with a payer-defined system URI such as https://{payer}/fhir/identifier/master-opt-out-list (and a stable value), while operation-emitted response instances either omit Group.identifier or use a distinct system URI such as https://{payer}/fhir/identifier/match-result. Payers that prefer a tag-based discriminator MAY instead use Group.meta.tag with a payer-defined coding. Group.code is not a reliable discriminator here because it is fixed-pattern to PdexMultiMemberMatchResultCS#consentconstraint on every conformant instance (see FHIR-56493). The Payer is the managing organization, and Group.member entries reference the patients who have exercised their right to opt-out, either broadly or for specific purposes or providers.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* Group Group of multiple entities
Constraints: grp-1
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique identifier for the opt-out group
Group.active This element must be supported. This element is included in summaries. 0..1 boolean Opt-out group is active
Required Pattern: true (extensions allowed)
Group.type This element must be supported. This element is included in summaries. 1..1 code Type of group (members)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person (extensions allowed)
Group.actual This element must be supported. This element is included in summaries. C 1..1 boolean This is an actual collection of members
Required Pattern: true (extensions allowed)
Group.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members who have opted out
Group.managingEntity This element must be supported. This element is included in summaries. 0..1 Reference(Organization) The Payer managing this opt-out group
Group.characteristic This element must be supported. 0..* BackboneElement Opt-out characteristics and scope
Group.characteristic.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Group.characteristic.Slices for extension.extension:optOutReason 0..1 CodeableConcept Reason for the opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-reason
Binding: Opt-Out Reason Value Set (required)
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Identifies this as a consent constraint group
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.characteristic.code.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: PDex Multi-Member Match Result Value Set (required)
Group.characteristic.value[x] This element must be supported. 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope Value Set (required)
Group.characteristic.exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period during which the opt-out is effective
Group.characteristic.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Opt-out effective date
Group.member This element must be supported. C 0..* BackboneElement Members who have opted out
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Patient) Member/patient who has opted out
Group.member.entity.Slices for extension Content/Rules for all slices
Group.member.entity.Slices for extension.extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
Group.member.inactive 0..1 boolean Whether the opt-out is currently active

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​code.coding Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​value[x] Base required Opt-Out Scope Value Set 📦2.2.1 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group Group of multiple entities
Group.identifier This element must be supported. 0..* Identifier Unique identifier for the opt-out group
Group.active This element must be supported. 0..1 boolean Opt-out group is active
Required Pattern: true (extensions allowed)
Group.type This element must be supported. 1..1 code Type of group (members)
Required Pattern: person (extensions allowed)
Group.code This element must be supported. 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.quantity This element must be supported. 0..1 unsignedInt Number of members who have opted out
Group.managingEntity This element must be supported. 0..1 Reference(Organization) The Payer managing this opt-out group
Group.characteristic This element must be supported. 0..* BackboneElement Opt-out characteristics and scope
Group.characteristic.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Group.characteristic.Slices for extension.extension:optOutReason 0..1 CodeableConcept Reason for the opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-reason
Binding: Opt-Out Reason Value Set (required)
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Identifies this as a consent constraint group
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.characteristic.code.coding 0..* Coding Code defined by a terminology system
Binding: PDex Multi-Member Match Result Value Set (required)
Group.characteristic.value[x] This element must be supported. 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope Value Set (required)
Group.characteristic.exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period during which the opt-out is effective
Group.characteristic.period.start This element must be supported. 0..1 dateTime Opt-out effective date
Group.member This element must be supported. 0..* BackboneElement Members who have opted out
Group.member.entity This element must be supported. 1..1 Reference(Patient) Member/patient who has opted out
Group.member.entity.Slices for extension Content/Rules for all slices
Group.member.entity.Slices for extension.extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
Group.member.inactive 0..1 boolean Whether the opt-out is currently active

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code.coding Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​value[x] Base required Opt-Out Scope Value Set 📦2.2.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* Group Group of multiple entities
Constraints: grp-1
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Group.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Group.contained 0..* Resource Contained, inline Resources
Group.extension 0..* Extension Additional content defined by implementations
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique identifier for the opt-out group
Group.active This element must be supported. This element is included in summaries. 0..1 boolean Opt-out group is active
Required Pattern: true (extensions allowed)
Group.type This element must be supported. This element is included in summaries. 1..1 code Type of group (members)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person (extensions allowed)
Group.actual This element must be supported. This element is included in summaries. C 1..1 boolean This is an actual collection of members
Required Pattern: true (extensions allowed)
Group.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.name This element is included in summaries. 0..1 string Label for Group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members who have opted out
Group.managingEntity This element must be supported. This element is included in summaries. 0..1 Reference(Organization) The Payer managing this opt-out group
Group.characteristic This element must be supported. 0..* BackboneElement Opt-out characteristics and scope
Group.characteristic.id 0..1 string Unique id for inter-element referencing
Group.characteristic.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Group.characteristic.Slices for extension.extension:optOutReason 0..1 CodeableConcept Reason for the opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-reason
Binding: Opt-Out Reason Value Set (required)
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Identifies this as a consent constraint group
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.characteristic.code.id 0..1 string Unique id for inter-element referencing
Group.characteristic.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.characteristic.code.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: PDex Multi-Member Match Result Value Set (required)
Group.characteristic.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
Group.characteristic.value[x] This element must be supported. 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope Value Set (required)
Group.characteristic.exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period during which the opt-out is effective
Group.characteristic.period.id 0..1 string Unique id for inter-element referencing
Group.characteristic.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.characteristic.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Opt-out effective date
Group.characteristic.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Group.member This element must be supported. C 0..* BackboneElement Members who have opted out
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.extension 0..* Extension Additional content defined by implementations
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Patient) Member/patient who has opted out
Group.member.entity.id 0..1 string Unique id for inter-element referencing
Group.member.entity.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.member.entity.Slices for extension.extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
Group.member.entity.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Group.member.entity.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Group.member.entity.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Group.member.entity.display This element is included in summaries. 0..1 string Text alternative for the resource
Group.member.period 0..1 Period Period member belonged to the group
Group.member.inactive 0..1 boolean Whether the opt-out is currently active

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​code.coding Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​value[x] Base required Opt-Out Scope Value Set 📦2.2.1 This IG
Group.member.entity.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Group

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* Group Group of multiple entities
Constraints: grp-1
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique identifier for the opt-out group
Group.active This element must be supported. This element is included in summaries. 0..1 boolean Opt-out group is active
Required Pattern: true (extensions allowed)
Group.type This element must be supported. This element is included in summaries. 1..1 code Type of group (members)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person (extensions allowed)
Group.actual This element must be supported. This element is included in summaries. C 1..1 boolean This is an actual collection of members
Required Pattern: true (extensions allowed)
Group.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members who have opted out
Group.managingEntity This element must be supported. This element is included in summaries. 0..1 Reference(Organization) The Payer managing this opt-out group
Group.characteristic This element must be supported. 0..* BackboneElement Opt-out characteristics and scope
Group.characteristic.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Group.characteristic.Slices for extension.extension:optOutReason 0..1 CodeableConcept Reason for the opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-reason
Binding: Opt-Out Reason Value Set (required)
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Identifies this as a consent constraint group
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.characteristic.code.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: PDex Multi-Member Match Result Value Set (required)
Group.characteristic.value[x] This element must be supported. 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope Value Set (required)
Group.characteristic.exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period during which the opt-out is effective
Group.characteristic.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Opt-out effective date
Group.member This element must be supported. C 0..* BackboneElement Members who have opted out
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Patient) Member/patient who has opted out
Group.member.entity.Slices for extension Content/Rules for all slices
Group.member.entity.Slices for extension.extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
Group.member.inactive 0..1 boolean Whether the opt-out is currently active

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​code.coding Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​value[x] Base required Opt-Out Scope Value Set 📦2.2.1 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group Group of multiple entities
Group.identifier This element must be supported. 0..* Identifier Unique identifier for the opt-out group
Group.active This element must be supported. 0..1 boolean Opt-out group is active
Required Pattern: true (extensions allowed)
Group.type This element must be supported. 1..1 code Type of group (members)
Required Pattern: person (extensions allowed)
Group.actual This element must be supported. 1..1 boolean This is an actual collection of members
Required Pattern: true (extensions allowed)
Group.code This element must be supported. 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.quantity This element must be supported. 0..1 unsignedInt Number of members who have opted out
Group.managingEntity This element must be supported. 0..1 Reference(Organization) The Payer managing this opt-out group
Group.characteristic This element must be supported. 0..* BackboneElement Opt-out characteristics and scope
Group.characteristic.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Group.characteristic.Slices for extension.extension:optOutReason 0..1 CodeableConcept Reason for the opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-reason
Binding: Opt-Out Reason Value Set (required)
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Identifies this as a consent constraint group
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.characteristic.code.coding 0..* Coding Code defined by a terminology system
Binding: PDex Multi-Member Match Result Value Set (required)
Group.characteristic.value[x] This element must be supported. 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope Value Set (required)
Group.characteristic.exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period during which the opt-out is effective
Group.characteristic.period.start This element must be supported. 0..1 dateTime Opt-out effective date
Group.member This element must be supported. 0..* BackboneElement Members who have opted out
Group.member.entity This element must be supported. 1..1 Reference(Patient) Member/patient who has opted out
Group.member.entity.Slices for extension Content/Rules for all slices
Group.member.entity.Slices for extension.extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
Group.member.inactive 0..1 boolean Whether the opt-out is currently active

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code.coding Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​value[x] Base required Opt-Out Scope Value Set 📦2.2.1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* Group Group of multiple entities
Constraints: grp-1
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Group.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Group.contained 0..* Resource Contained, inline Resources
Group.extension 0..* Extension Additional content defined by implementations
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique identifier for the opt-out group
Group.active This element must be supported. This element is included in summaries. 0..1 boolean Opt-out group is active
Required Pattern: true (extensions allowed)
Group.type This element must be supported. This element is included in summaries. 1..1 code Type of group (members)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person (extensions allowed)
Group.actual This element must be supported. This element is included in summaries. C 1..1 boolean This is an actual collection of members
Required Pattern: true (extensions allowed)
Group.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.name This element is included in summaries. 0..1 string Label for Group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members who have opted out
Group.managingEntity This element must be supported. This element is included in summaries. 0..1 Reference(Organization) The Payer managing this opt-out group
Group.characteristic This element must be supported. 0..* BackboneElement Opt-out characteristics and scope
Group.characteristic.id 0..1 string Unique id for inter-element referencing
Group.characteristic.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Group.characteristic.Slices for extension.extension:optOutReason 0..1 CodeableConcept Reason for the opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-reason
Binding: Opt-Out Reason Value Set (required)
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Identifies this as a consent constraint group
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS",
      "code" : "consentconstraint",
      "display" : "Consent Constraint"
    }
  ]
}
Group.characteristic.code.id 0..1 string Unique id for inter-element referencing
Group.characteristic.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.characteristic.code.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: PDex Multi-Member Match Result Value Set (required)
Group.characteristic.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
Group.characteristic.value[x] This element must be supported. 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope Value Set (required)
Group.characteristic.exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period during which the opt-out is effective
Group.characteristic.period.id 0..1 string Unique id for inter-element referencing
Group.characteristic.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.characteristic.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Opt-out effective date
Group.characteristic.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Group.member This element must be supported. C 0..* BackboneElement Members who have opted out
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.extension 0..* Extension Additional content defined by implementations
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Patient) Member/patient who has opted out
Group.member.entity.id 0..1 string Unique id for inter-element referencing
Group.member.entity.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.member.entity.Slices for extension.extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
Group.member.entity.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Group.member.entity.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Group.member.entity.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Group.member.entity.display This element is included in summaries. 0..1 string Text alternative for the resource
Group.member.period 0..1 Period Period member belonged to the group
Group.member.inactive 0..1 boolean Whether the opt-out is currently active

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​code.coding Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​value[x] Base required Opt-Out Scope Value Set 📦2.2.1 This IG
Group.member.entity.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Group

 

Other representations of profile: CSV, Excel, Schematron