Da Vinci Payer Data Exchange
2.1.1 - STU 2.1 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.1.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/member-opt-out-group Version: 2.1.1
Standards status: Trial-use Maturity Level: 2 Computable Name: MemberOptOut

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

A Group resource representing members who have opted out of data sharing. The Payer is the managing organization. The group members are the patients who have exercised their right to opt-out of sharing their health information, either broadly or for specific purposes or providers. This group is used to identify members whose data should not be shared in payer-to-payer or provider access scenarios.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier for the opt-out group
... type SΣ 1..1 code Type of group (members)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual SΣC 1..1 boolean This is an actual collection of members
Required Pattern: true
... code SΣ 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
... quantity SΣ 0..1 unsignedInt Number of members who have opted out
... managingEntity SΣ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) The Payer managing this opt-out group
... characteristic S 0..* BackboneElement Opt-out characteristics and scope
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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 (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Identifies the opt-out scope
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 0..1 uri Identity of the terminology system
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: opt-out-scope
...... display 1..1 string Representation defined by the system
Fixed Value: Opt-Out Scope
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value[x] S 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope (required)
.... exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false
.... period S 0..1 Period Period during which the opt-out is effective
..... start SΣC 0..1 dateTime Opt-out effective date
... member SC 0..* BackboneElement Members who have opted out
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Patient) Member/patient who has opted out
..... Slices for extension Content/Rules for all slices
...... extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
.... 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.1.1 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base required Opt-Out Scope 📦2.1.1 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
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()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... identifier S 0..* Identifier Unique identifier for the opt-out group
... active S 0..1 boolean Opt-out group is active
Required Pattern: true
... type S 1..1 code Type of group (members)
Required Pattern: person
... code S 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
... quantity S 0..1 unsignedInt Number of members who have opted out
... managingEntity S 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) The Payer managing this opt-out group
... characteristic S 0..* BackboneElement Opt-out characteristics and scope
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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 (required)
.... code S 1..1 CodeableConcept Identifies the opt-out scope
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: opt-out-scope
...... display 1..1 string Representation defined by the system
Fixed Value: Opt-Out Scope
.... value[x] S 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope (required)
.... exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false
.... period S 0..1 Period Period during which the opt-out is effective
..... start S 0..1 dateTime Opt-out effective date
... member S 0..* BackboneElement Members who have opted out
.... entity S 1..1 Reference(Patient) Member/patient who has opted out
..... Slices for extension Content/Rules for all slices
...... extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
.... 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.1.1 This IG
Group.characteristic.​value[x] Base required Opt-Out Scope 📦2.1.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier for the opt-out group
... active SΣ 0..1 boolean Opt-out group is active
Required Pattern: true
... type SΣ 1..1 code Type of group (members)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual SΣC 1..1 boolean This is an actual collection of members
Required Pattern: true
... code SΣ 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
... name Σ 0..1 string Label for Group
... quantity SΣ 0..1 unsignedInt Number of members who have opted out
... managingEntity SΣ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) The Payer managing this opt-out group
... characteristic S 0..* BackboneElement Opt-out characteristics and scope
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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 (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Identifies the opt-out scope
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 0..1 uri Identity of the terminology system
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: opt-out-scope
...... display 1..1 string Representation defined by the system
Fixed Value: Opt-Out Scope
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value[x] S 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope (required)
.... exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false
.... period S 0..1 Period Period during which the opt-out is effective
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 0..1 dateTime Opt-out effective date
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... member SC 0..* BackboneElement Members who have opted out
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Patient) Member/patient who has opted out
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... period 0..1 Period Period member belonged to the group
.... 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.1.1 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base required Opt-Out Scope 📦2.1.1 This IG
Group.member.entity.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
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()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier for the opt-out group
... type SΣ 1..1 code Type of group (members)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual SΣC 1..1 boolean This is an actual collection of members
Required Pattern: true
... code SΣ 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
... quantity SΣ 0..1 unsignedInt Number of members who have opted out
... managingEntity SΣ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) The Payer managing this opt-out group
... characteristic S 0..* BackboneElement Opt-out characteristics and scope
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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 (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Identifies the opt-out scope
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 0..1 uri Identity of the terminology system
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: opt-out-scope
...... display 1..1 string Representation defined by the system
Fixed Value: Opt-Out Scope
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value[x] S 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope (required)
.... exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false
.... period S 0..1 Period Period during which the opt-out is effective
..... start SΣC 0..1 dateTime Opt-out effective date
... member SC 0..* BackboneElement Members who have opted out
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Patient) Member/patient who has opted out
..... Slices for extension Content/Rules for all slices
...... extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
.... 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.1.1 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base required Opt-Out Scope 📦2.1.1 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
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()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... identifier S 0..* Identifier Unique identifier for the opt-out group
... active S 0..1 boolean Opt-out group is active
Required Pattern: true
... type S 1..1 code Type of group (members)
Required Pattern: person
... code S 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
... quantity S 0..1 unsignedInt Number of members who have opted out
... managingEntity S 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) The Payer managing this opt-out group
... characteristic S 0..* BackboneElement Opt-out characteristics and scope
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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 (required)
.... code S 1..1 CodeableConcept Identifies the opt-out scope
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: opt-out-scope
...... display 1..1 string Representation defined by the system
Fixed Value: Opt-Out Scope
.... value[x] S 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope (required)
.... exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false
.... period S 0..1 Period Period during which the opt-out is effective
..... start S 0..1 dateTime Opt-out effective date
... member S 0..* BackboneElement Members who have opted out
.... entity S 1..1 Reference(Patient) Member/patient who has opted out
..... Slices for extension Content/Rules for all slices
...... extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
.... 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.1.1 This IG
Group.characteristic.​value[x] Base required Opt-Out Scope 📦2.1.1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier for the opt-out group
... active SΣ 0..1 boolean Opt-out group is active
Required Pattern: true
... type SΣ 1..1 code Type of group (members)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual SΣC 1..1 boolean This is an actual collection of members
Required Pattern: true
... code SΣ 0..1 CodeableConcept Kind of group (opt-out)
Binding: PDex Multi-Member Match Result Value Set (required)
... name Σ 0..1 string Label for Group
... quantity SΣ 0..1 unsignedInt Number of members who have opted out
... managingEntity SΣ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) The Payer managing this opt-out group
... characteristic S 0..* BackboneElement Opt-out characteristics and scope
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... 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 (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Identifies the opt-out scope
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 0..1 uri Identity of the terminology system
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: opt-out-scope
...... display 1..1 string Representation defined by the system
Fixed Value: Opt-Out Scope
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value[x] S 1..1 CodeableConcept The type of opt-out
Binding: Opt-Out Scope (required)
.... exclude 1..1 boolean This is an include, not an exclude
Required Pattern: false
.... period S 0..1 Period Period during which the opt-out is effective
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 0..1 dateTime Opt-out effective date
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... member SC 0..* BackboneElement Members who have opted out
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Patient) Member/patient who has opted out
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:optOutDetails 0..1 string Details of the member's opt-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/opt-out-details
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... period 0..1 Period Period member belonged to the group
.... 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.1.1 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base required Opt-Out Scope 📦2.1.1 This IG
Group.member.entity.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
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()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

 

Other representations of profile: CSV, Excel, Schematron