Bulk Data Access IG
3.0.0-ballot - STU 3 - Ballot
Bulk Data Access IG
3.0.0-ballot - STU 3 - Ballot
This page is part of the FHIR Bulk Data Access (Flat FHIR) (v3.0.0-ballot: STU3 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/bulk-cohort-group | Version: 3.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 5 | Computable Name: BulkCohortGroup | ||
Group that provides characteristic based cohorts through coarse-grained, REST search expression based filters to support constraining bulk export requests
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 |
  Slices for extension |
0..* | Extension | when membership in this group was updated Slice: Unordered, Open by value:url | |
   extension:members-refreshed |
0..1 | dateTime | Members Refreshed URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed | |
 Slices for modifierExtension |
?! | 1..* | Extension | Filter for members of this group Slice: Unordered, Open by value:url |
| modifierExtension:member-filter |
?! | 1..* | Expression | Member Filter URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter |
| type |
Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: Person and Practitioner from GroupType Value Set (required) |
| actual |
ΣC | 1..1 | boolean | True if the member element is populated, otherwise false. |
| name |
Σ | 1..1 | string | Label for Group |
  member |
C | 0..* | BackboneElement | Who or what is in group |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
  entity |
1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Group.type | required | GroupTypeSubsethttp://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subsetFrom this IG | |
| Group.characteristic.code | example | ||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Group |
0..* | Group | Group of multiple entities | |
| Slices for extension |
0..* | Extension | when membership in this group was updated Slice: Unordered, Open by value:url | |
| extension:members-refreshed |
0..1 | dateTime | Members Refreshed URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed | |
| Slices for modifierExtension |
1..* | Extension | Filter for members of this group Slice: Unordered, Open by value:url | |
| modifierExtension:member-filter |
1..* | Expression | Member Filter URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter | |
 type |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: Person and Practitioner from GroupType Value Set (required) | |
| actual |
1..1 | boolean | True if the member element is populated, otherwise false. | |
| name |
1..1 | string | Label for Group | |
| characteristic |
0..0 | |||
| member |
0..* | BackboneElement | Who or what is in group | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Group.type | required | GroupTypeSubsethttp://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subsetFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | when membership in this group was updated Slice: Unordered, Open by value:url | |||||
| extension:members-refreshed |
0..1 | dateTime | Members Refreshed URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed | |||||
| Slices for modifierExtension |
?! | 1..* | Extension | Filter for members of this group Slice: Unordered, Open by value:url | ||||
| modifierExtension:member-filter |
?! | 1..* | Expression | Member Filter URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter | ||||
| identifier |
Σ | 0..* | Identifier | Unique id | ||||
| active |
Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type |
Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: Person and Practitioner from GroupType Value Set (required) | ||||
| actual |
ΣC | 1..1 | boolean | True if the member element is populated, otherwise false. | ||||
| code |
Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name |
Σ | 1..1 | string | Label for Group | ||||
| quantity |
Σ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity |
Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
| member |
C | 0..* | BackboneElement | Who or what is in group | ||||
| 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 |
1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |||||
| period |
0..1 | Period | Period member belonged to the group | |||||
| inactive |
0..1 | boolean | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Group.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Group.type | required | GroupTypeSubsethttp://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subsetFrom this IG | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Summary
Mandatory: 3 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Maturity: 5
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| Slices for extension |
0..* | Extension | when membership in this group was updated Slice: Unordered, Open by value:url | |
| extension:members-refreshed |
0..1 | dateTime | Members Refreshed URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed | |
| Slices for modifierExtension |
?! | 1..* | Extension | Filter for members of this group Slice: Unordered, Open by value:url |
| modifierExtension:member-filter |
?! | 1..* | Expression | Member Filter URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter |
| type |
Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: Person and Practitioner from GroupType Value Set (required) |
| actual |
ΣC | 1..1 | boolean | True if the member element is populated, otherwise false. |
| name |
Σ | 1..1 | string | Label for Group |
| member |
C | 0..* | BackboneElement | Who or what is in group |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity |
1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Group.type | required | GroupTypeSubsethttp://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subsetFrom this IG | |
| Group.characteristic.code | example | ||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Group |
0..* | Group | Group of multiple entities | |
| Slices for extension |
0..* | Extension | when membership in this group was updated Slice: Unordered, Open by value:url | |
| extension:members-refreshed |
0..1 | dateTime | Members Refreshed URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed | |
| Slices for modifierExtension |
1..* | Extension | Filter for members of this group Slice: Unordered, Open by value:url | |
| modifierExtension:member-filter |
1..* | Expression | Member Filter URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter | |
| type |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: Person and Practitioner from GroupType Value Set (required) | |
| actual |
1..1 | boolean | True if the member element is populated, otherwise false. | |
| name |
1..1 | string | Label for Group | |
| characteristic |
0..0 | |||
| member |
0..* | BackboneElement | Who or what is in group | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Group.type | required | GroupTypeSubsethttp://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subsetFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | when membership in this group was updated Slice: Unordered, Open by value:url | |||||
| extension:members-refreshed |
0..1 | dateTime | Members Refreshed URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed | |||||
| Slices for modifierExtension |
?! | 1..* | Extension | Filter for members of this group Slice: Unordered, Open by value:url | ||||
| modifierExtension:member-filter |
?! | 1..* | Expression | Member Filter URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter | ||||
| identifier |
Σ | 0..* | Identifier | Unique id | ||||
| active |
Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type |
Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: Person and Practitioner from GroupType Value Set (required) | ||||
| actual |
ΣC | 1..1 | boolean | True if the member element is populated, otherwise false. | ||||
| code |
Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name |
Σ | 1..1 | string | Label for Group | ||||
| quantity |
Σ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity |
Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
| member |
C | 0..* | BackboneElement | Who or what is in group | ||||
| 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 |
1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |||||
| period |
0..1 | Period | Period member belonged to the group | |||||
| inactive |
0..1 | boolean | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Group.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Group.type | required | GroupTypeSubsethttp://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subsetFrom this IG | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Summary
Mandatory: 3 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Maturity: 5
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / FHIR Infrastructure and Boston Children's Hospital. Package hl7.fhir.uv.bulkdata#3.0.0-ballot based on FHIR 4.0.1. Generated 2025-08-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change