Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablegroup | Version: 2.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: CRMIPublishableGroup | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.70 | ||||
Supports declaration of the group metadata required by HL7 and other organizations that share and publish groups with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.
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 | 1..1 | CRMIGroupDefinition | Group of multiple entities Constraints: grp-1, gdf-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:library |
S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library |
| extension:expression |
S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| extension:date |
S | 1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date |
| extension:contact |
S | 0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact |
| extension:useContext |
S | 0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext |
| extension:jurisdiction |
S | 0..* | CodeableConcept | Intended jurisdiction for artifact (if applicable) URL: http://hl7.org/fhir/StructureDefinition/artifact-jurisdiction Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| extension:purpose |
S | 0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose |
| extension:usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage |
| extension:copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright |
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| extension:approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| extension:lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| extension:effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| extension:topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
 extension:relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 0..* | Identifier | Unique id |
| active |
SΣ | 0..1 | boolean | Whether this group's record is in active use |
| type |
SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual |
SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: false |
| code |
SΣ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
| name |
SΣ | 1..1 | string | Label for Group |
 managingEntity |
SΣ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition |
  Slices for extension |
Content/Rules for all slices | |||
  extension:profile |
S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
 value[x] |
1..1 | canonical() | Value of extension | |
| characteristic |
S | 0..* | BackboneElement | Include / Exclude group members by Trait |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
 value[x] |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||
| valueCodeableConcept |
CodeableConcept | |||
| valueBoolean |
boolean | |||
| valueQuantity |
Quantity | |||
| valueRange |
Range | |||
 valueReference |
Reference(Any) | |||
| exclude |
1..1 | boolean | Group includes or excludes | |
| member |
SC | 0..* | BackboneElement | Who or what is in group |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity |
S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member |
| Slices for extension |
Content/Rules for all slices | |||
 extension:profile |
S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
| value[x] |
C | 1..1 | canonical() | Value of extension Constraints: gdf-2 |
| extension:nonCanonicalReference |
S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | example | Not Stated | Unknown | |
| Group.characteristic.code | Base | example | Not Stated | Unknown | |
| Group.characteristic.value[x] | Base | example | Not Stated | Unknown |
| 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()
|
| gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both |
extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists()
|
| gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition |
resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition')
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
This structure is derived from CRMIGroupDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Group |
C | 1..1 | CRMIGroupDefinition | Group of multiple entities Constraints: grp-1, gdf-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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:library |
S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | ||||
| extension:expression |
S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| extension:date |
S | 1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | ||||
| extension:contact |
S | 0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | ||||
| extension:useContext |
S | 0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | ||||
| extension:jurisdiction |
S | 0..* | CodeableConcept | Intended jurisdiction for artifact (if applicable) URL: http://hl7.org/fhir/StructureDefinition/artifact-jurisdiction Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| extension:purpose |
S | 0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | ||||
| extension:usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| extension:copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | ||||
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| extension:approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| extension:lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| extension:effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| extension:topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| extension:relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | Unique id | ||||
| active |
SΣ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type |
SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
| actual |
SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: false | ||||
| code |
SΣ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name |
SΣ | 1..1 | string | Label for Group | ||||
| quantity |
Σ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity |
SΣ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
| 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:profile |
S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
| value[x] |
1..1 | canonical() | Value of extension | |||||
| 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 | ||||
| characteristic |
S | 0..* | BackboneElement | Include / Exclude group members by Trait | ||||
| 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 | ||||
| code |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
| value[x] |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueBoolean |
boolean | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(Any) | |||||||
| exclude |
1..1 | boolean | Group includes or excludes | |||||
| period |
0..1 | Period | Period over which characteristic is tested | |||||
| member |
SC | 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 |
S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | ||||
| 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:profile |
S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
| value[x] |
C | 1..1 | canonical() | Value of extension Constraints: gdf-2 | ||||
| extension:nonCanonicalReference |
S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | ||||
| 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 | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| 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 | example | Not Stated | Unknown | |
| Group.managingEntity.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Group.characteristic.code | Base | example | Not Stated | Unknown | |
| Group.characteristic.value[x] | Base | example | Not Stated | Unknown | |
| Group.member.entity.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
| gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both |
extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists()
|
| gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition |
resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition')
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
This structure is derived from CRMIGroupDefinition
Summary
Mandatory: 1 element
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Group |
C | 1..1 | CRMIGroupDefinition | Group of multiple entities Constraints: grp-1, gdf-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:library |
S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library |
| extension:expression |
S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| extension:date |
S | 1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date |
| extension:contact |
S | 0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact |
| extension:useContext |
S | 0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext |
| extension:jurisdiction |
S | 0..* | CodeableConcept | Intended jurisdiction for artifact (if applicable) URL: http://hl7.org/fhir/StructureDefinition/artifact-jurisdiction Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| extension:purpose |
S | 0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose |
| extension:usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage |
| extension:copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright |
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| extension:approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| extension:lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| extension:effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| extension:topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| extension:relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 0..* | Identifier | Unique id |
| active |
SΣ | 0..1 | boolean | Whether this group's record is in active use |
| type |
SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual |
SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: false |
| code |
SΣ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
| name |
SΣ | 1..1 | string | Label for Group |
| managingEntity |
SΣ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition |
| Slices for extension |
Content/Rules for all slices | |||
| extension:profile |
S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
| value[x] |
1..1 | canonical() | Value of extension | |
| characteristic |
S | 0..* | BackboneElement | Include / Exclude group members by Trait |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
| value[x] |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||
| valueCodeableConcept |
CodeableConcept | |||
| valueBoolean |
boolean | |||
| valueQuantity |
Quantity | |||
| valueRange |
Range | |||
| valueReference |
Reference(Any) | |||
| exclude |
1..1 | boolean | Group includes or excludes | |
| member |
SC | 0..* | BackboneElement | Who or what is in group |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity |
S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member |
| Slices for extension |
Content/Rules for all slices | |||
| extension:profile |
S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
| value[x] |
C | 1..1 | canonical() | Value of extension Constraints: gdf-2 |
| extension:nonCanonicalReference |
S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | example | Not Stated | Unknown | |
| Group.characteristic.code | Base | example | Not Stated | Unknown | |
| Group.characteristic.value[x] | Base | example | Not Stated | Unknown |
| 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()
|
| gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both |
extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists()
|
| gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition |
resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition')
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
Differential View
This structure is derived from CRMIGroupDefinition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Group |
C | 1..1 | CRMIGroupDefinition | Group of multiple entities Constraints: grp-1, gdf-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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:library |
S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | ||||
| extension:expression |
S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| extension:date |
S | 1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | ||||
| extension:contact |
S | 0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | ||||
| extension:useContext |
S | 0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | ||||
| extension:jurisdiction |
S | 0..* | CodeableConcept | Intended jurisdiction for artifact (if applicable) URL: http://hl7.org/fhir/StructureDefinition/artifact-jurisdiction Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| extension:purpose |
S | 0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | ||||
| extension:usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| extension:copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | ||||
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| extension:approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| extension:lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| extension:effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| extension:topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| extension:relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | Unique id | ||||
| active |
SΣ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type |
SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
| actual |
SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: false | ||||
| code |
SΣ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name |
SΣ | 1..1 | string | Label for Group | ||||
| quantity |
Σ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity |
SΣ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
| 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:profile |
S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
| value[x] |
1..1 | canonical() | Value of extension | |||||
| 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 | ||||
| characteristic |
S | 0..* | BackboneElement | Include / Exclude group members by Trait | ||||
| 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 | ||||
| code |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
| value[x] |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueBoolean |
boolean | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(Any) | |||||||
| exclude |
1..1 | boolean | Group includes or excludes | |||||
| period |
0..1 | Period | Period over which characteristic is tested | |||||
| member |
SC | 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 |
S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | ||||
| 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:profile |
S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
| value[x] |
C | 1..1 | canonical() | Value of extension Constraints: gdf-2 | ||||
| extension:nonCanonicalReference |
S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | ||||
| 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 | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| 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 | example | Not Stated | Unknown | |
| Group.managingEntity.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Group.characteristic.code | Base | example | Not Stated | Unknown | |
| Group.characteristic.value[x] | Base | example | Not Stated | Unknown | |
| Group.member.entity.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
| gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both |
extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists()
|
| gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition |
resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition')
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
This structure is derived from CRMIGroupDefinition
Summary
Mandatory: 1 element
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-10-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
