Bulk Data Access IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/bulk-data/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• JSON

Resource Profile: Bulk Cohort Group

Group that provides characteristic based cohorts through coarse-grained, REST search expression based filters to support constraining bulk export requests

Usage:

• Examples for this Resource Profile: BC with DM Dx and January Ambulatory Encounter

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Group

Name	Flags	Card.	Type	Description & Constraints
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
membersRefreshed		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:memberFilter		1..*	MemberFilter	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	Group members are described by memberFilter extension Required Pattern: false
name		1..1	string	Label for Group
characteristic		0..0
member		0..*	BackboneElement	Who or what is in group
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Group.type	required	GroupTypeSubset http://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subset from this IG

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Group of multiple entities grp-1: Can only have members if group is "actual"
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
membersRefreshed		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:memberFilter	?!	1..*	MemberFilter	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	Group members are described by memberFilter extension Required Pattern: 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

Terminology Bindings

Path	Conformance	ValueSet	URI
Group.type	required	GroupTypeSubset http://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subset from this IG
Group.characteristic.code	example
Group.characteristic.value[x]	example

Constraints

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)

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Group of multiple entities grp-1: Can only have members if group is "actual"
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	when membership in this group was updated Slice: Unordered, Open by value:url
membersRefreshed		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:memberFilter	?!	1..*	MemberFilter	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	Group members are described by memberFilter extension Required Pattern: false
code	Σ	0..1	CodeableConcept	Kind of Group members Binding Description (No ValueSet): (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

Terminology Bindings

Path	Conformance	ValueSet	URI
Group.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Group.type	required	GroupTypeSubset http://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subset from this IG
Group.code	example
Group.characteristic.code	example
Group.characteristic.value[x]	example

Constraints

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:

• http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed
• http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter (Modifier)

Differential View

This structure is derived from Group

Name	Flags	Card.	Type	Description & Constraints
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
membersRefreshed		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:memberFilter		1..*	MemberFilter	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	Group members are described by memberFilter extension Required Pattern: false
name		1..1	string	Label for Group
characteristic		0..0
member		0..*	BackboneElement	Who or what is in group
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Group.type	required	GroupTypeSubset http://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subset from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Group of multiple entities grp-1: Can only have members if group is "actual"
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
membersRefreshed		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:memberFilter	?!	1..*	MemberFilter	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	Group members are described by memberFilter extension Required Pattern: 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

Terminology Bindings

Path	Conformance	ValueSet	URI
Group.type	required	GroupTypeSubset http://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subset from this IG
Group.characteristic.code	example
Group.characteristic.value[x]	example

Constraints

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)

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Group of multiple entities grp-1: Can only have members if group is "actual"
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	when membership in this group was updated Slice: Unordered, Open by value:url
membersRefreshed		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:memberFilter	?!	1..*	MemberFilter	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	Group members are described by memberFilter extension Required Pattern: false
code	Σ	0..1	CodeableConcept	Kind of Group members Binding Description (No ValueSet): (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

Terminology Bindings

Path	Conformance	ValueSet	URI
Group.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Group.type	required	GroupTypeSubset http://hl7.org/fhir/uv/bulkdata/ValueSet/group-type-subset from this IG
Group.code	example
Group.characteristic.code	example
Group.characteristic.value[x]	example

Constraints

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:

• http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed
• http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter (Modifier)

Other representations of profile: CSV, Excel, Schematron