HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)
This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Group
A set of entities (personnel, material, or places) to be considered together. May be a pool of like-type resources, a team, or combination of personnel, material and places.
This profile builds on Group.
This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC).
View the corresponding GroupModel logical model.
Summary
Structures
This structure refers to these other structures:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.entity.Group maps to Group: ActiveFlag maps to active Type maps to type Actual maps to actual Title maps to name GroupCharacteristic maps to characteristic.value[x] GroupCharacteristic.GroupCharacteristicCode maps to characteristic.code GroupCharacteristic.ExcludeFlag maps to characteristic.exclude GroupCharacteristic.TimePeriod maps to characteristic.period Member.Patient maps to member.entity Member.Practitioner maps to member.entity Member.Device maps to member.entity Member.Medication maps to member.entity Member.Substance maps to member.entity Member.ParticipationPeriod maps to member.period Member.ActiveFlag maps to member.inactive // TODO this is an inverse TF mapping Count maps to quantity
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Group | BC Group Profile | |||
 member | ||||
  entity | Reference(US Core Patient Profile | BC Practitioner Profile | US Core Device Profile | BC Medication Profile | BC Substance Profile) | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | I | 0..* | BC Group Profile 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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: GroupType (required) |
| actual | ΣI | 1..1 | boolean | Descriptive or actual |
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example) |
| name | Σ | 0..1 | string | Label for Group |
| quantity | Σ | 0..1 | unsignedInt | Number of members |
| characteristic | I | 0..* | BackboneElement | Trait of group members |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example) | |
 value[x] | 1..1 | CodeableConcept, boolean, Quantity, Range | Value held by characteristic Binding: (unbound) (example) | |
| exclude | ?! | 1..1 | boolean | Group includes or excludes |
| period | 0..1 | Period | Period over which characteristic is tested | |
| member | I | 0..* | BackboneElement | Who or what is in group |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| entity | 1..1 | Reference(US Core Patient Profile | BC Practitioner Profile | US Core Device Profile | BC Medication Profile | BC Substance Profile) | 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 | ||||
Summary
Structures
This structure refers to these other structures:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.entity.Group maps to Group: ActiveFlag maps to active Type maps to type Actual maps to actual Title maps to name GroupCharacteristic maps to characteristic.value[x] GroupCharacteristic.GroupCharacteristicCode maps to characteristic.code GroupCharacteristic.ExcludeFlag maps to characteristic.exclude GroupCharacteristic.TimePeriod maps to characteristic.period Member.Patient maps to member.entity Member.Practitioner maps to member.entity Member.Device maps to member.entity Member.Medication maps to member.entity Member.Substance maps to member.entity Member.ParticipationPeriod maps to member.period Member.ActiveFlag maps to member.inactive // TODO this is an inverse TF mapping Count maps to quantity
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | BC Group Profile | |||
| member | ||||
| entity | Reference(US Core Patient Profile | BC Practitioner Profile | US Core Device Profile | BC Medication Profile | BC Substance Profile) | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | I | 0..* | BC Group Profile 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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: GroupType (required) |
| actual | ΣI | 1..1 | boolean | Descriptive or actual |
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example) |
| name | Σ | 0..1 | string | Label for Group |
| quantity | Σ | 0..1 | unsignedInt | Number of members |
| characteristic | I | 0..* | BackboneElement | Trait of group members |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example) | |
| value[x] | 1..1 | CodeableConcept, boolean, Quantity, Range | Value held by characteristic Binding: (unbound) (example) | |
| exclude | ?! | 1..1 | boolean | Group includes or excludes |
| period | 0..1 | Period | Period over which characteristic is tested | |
| member | I | 0..* | BackboneElement | Who or what is in group |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| entity | 1..1 | Reference(US Core Patient Profile | BC Practitioner Profile | US Core Device Profile | BC Medication Profile | BC Substance Profile) | 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 | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Name | Conformance | ValueSet |
| Group.language | Common Languages | extensible | Common Languages |
| Group.type | GroupType | required | GroupType |
| Group.code | ?ext | example | |
| Group.characteristic.code | ?ext | example | |
| Group.characteristic.value[x] | ?ext | example |
| Id | Path | Details | Requirements |
| dom-2 | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Group | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | 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-3 | Group | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| grp-1 | Group | Can only have members if group is "actual" : member.empty() or (actual = true) | |
| ele-1 | Group.characteristic | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Group.member | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |