Bulk Data Access IG
2.0.0 - ci-build
Bulk Data Access IG
2.0.0 - ci-build
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
| Official URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/bulk-cohort-group | Version: 2.0.0 | |||
| Draft as of 2025-02-26 | Computable Name: BulkCohortGroup | |||
Group that provides characteristic based cohorts through coarse-grained, REST search expression based filters to support constraining bulk export requests
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Group |
C | 0..* | Group | Group of multiple entities dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management grp-1: Can only have members if group is "actual" |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
0..* | Extension | when membership in this group was updated Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   members-refreshed |
0..1 | dateTime | Members Refreshed URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 Slices for modifierExtension |
?! | 1..* | Extension | Filter for members of this group Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension:member-filter |
?! | 1..* | MemberFilter | Member Filter ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: Person and Practitioner from GroupType Value Set (required) ele-1: All FHIR elements must have a @value or children |
| actual |
ΣC | 1..1 | boolean | True if the member element is populated, otherwise false. ele-1: All FHIR elements must have a @value or children |
| name |
Σ | 1..1 | string | Label for Group ele-1: All FHIR elements must have a @value or children |
  member |
C | 0..* | BackboneElement | Who or what is in group ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
  entity |
1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member ele-1: All FHIR elements must have a @value or children | |
| 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) |
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / FHIR Infrastructure and Boston Children's Hospital. Package hl7.fhir.uv.bulkdata#2.0.0 based on FHIR 4.0.1. Generated 2025-02-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
