Content Repository 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 3.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: 3.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 Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | CRMIGroupDefinition | Group of multiple entities Constraints: grp-1, gdf-1, pub-1 |
![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
![]() ![]() ![]() |
0..1 | Expression | Criteria for group membership URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression | |
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() |
1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | |
![]() ![]() ![]() |
0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | |
![]() ![]() ![]() |
0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | |
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | |
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |
![]() ![]() ![]() |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | |
![]() ![]() ![]() |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | |
![]() ![]() ![]() |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |
![]() ![]() ![]() ![]() |
1..1 | RelatedArtifact | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | |
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Unique id | |
![]() ![]() |
0..1 | boolean | Whether this group's record is in active use | |
![]() ![]() |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person (no extensions allowed) | |
![]() ![]() |
C | 1..1 | boolean | Descriptive or actual Fixed Value: false (no extensions allowed) |
![]() ![]() |
0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | |
![]() ![]() |
1..1 | string | Label for Group | |
![]() ![]() |
0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | canonical() | Value of extension | |
![]() ![]() |
0..* | BackboneElement | Include / Exclude group members by Trait | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
![]() ![]() ![]() |
1..1 | Value held by characteristic Slice: Unordered, Closed by type:$this Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Reference(Any) | |||
![]() ![]() ![]() ![]() |
0..1 | Reference() | Value held by characteristic | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | canonical() | Instances that conform to the referenced profile URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-groupCharacteristicValueCanonical | |
![]() ![]() ![]() |
1..1 | boolean | Group includes or excludes | |
![]() ![]() |
C | 0..* | BackboneElement | Who or what is in group |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | canonical() | Value of extension Constraints: gdf-2 |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.extension:relatedArtifact.value[x].type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | example | Not State | Unknown | |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueCodeableConcept | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueQuantity | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueRange | Base | example | Not State | 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 a characteristicExpression or characteristics, but not both |
extension('http://hl7.org/fhir/StructureDefinition/characteristicExpression').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)
|
| pub-1 | error | Group | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
This structure is derived from CRMIGroupDefinition
| Id | Grade | Path(s) | Description | Expression |
| pub-1 | error | Group | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 1..1 | CRMIGroupDefinition | Group of multiple entities Constraints: grp-1, gdf-1, pub-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
0..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |||||
![]() ![]() ![]() |
0..1 | Expression | Criteria for group membership URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression | |||||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
![]() ![]() ![]() |
1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | |||||
![]() ![]() ![]() |
0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
![]() ![]() ![]() |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | |||||
![]() ![]() ![]() |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | |||||
![]() ![]() ![]() |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |||||
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |||||
![]() ![]() ![]() ![]() |
1..1 | RelatedArtifact | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Short label | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Brief description of the related artifact | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | markdown | Bibliographic citation for the artifact | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Where the artifact can be accessed | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | What document is being referenced | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | canonical(Resource) | What resource is being referenced | |||||
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Unique id | |||||
![]() ![]() |
0..1 | boolean | Whether this group's record is in active use | |||||
![]() ![]() |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person (no extensions allowed) | |||||
![]() ![]() |
C | 1..1 | boolean | Descriptive or actual Fixed Value: false (no extensions allowed) | ||||
![]() ![]() |
0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | |||||
![]() ![]() |
1..1 | string | Label for Group | |||||
![]() ![]() |
0..1 | unsignedInt | Number of members | |||||
![]() ![]() |
0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | canonical() | Value of extension | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
![]() ![]() ![]() |
1..1 | Value held by characteristic Slice: Unordered, Closed by type:$this Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() ![]() |
0..1 | Reference() | Value held by characteristic | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | canonical() | Instances that conform to the referenced profile URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-groupCharacteristicValueCanonical | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() ![]() |
1..1 | boolean | Group includes or excludes | |||||
![]() ![]() ![]() |
0..1 | Period | Period over which characteristic is tested | |||||
![]() ![]() |
C | 0..* | BackboneElement | Who or what is in group | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | canonical() | Value of extension Constraints: gdf-2 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() ![]() |
0..1 | Period | Period member belonged to the group | |||||
![]() ![]() ![]() |
0..1 | boolean | If member is no longer in group | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Group.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Group.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Group.extension:relatedArtifact.value[x].type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | example | Not State | Unknown | |
| Group.managingEntity.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueReference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Group.characteristic.value[x]:valueCodeableConcept | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueQuantity | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueRange | Base | example | Not State | 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 a characteristicExpression or characteristics, but not both |
extension('http://hl7.org/fhir/StructureDefinition/characteristicExpression').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)
|
| pub-1 | error | Group | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
This structure is derived from CRMIGroupDefinition
Summary
Mandatory: 1 element
Must-Support: 22 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | CRMIGroupDefinition | Group of multiple entities Constraints: grp-1, gdf-1, pub-1 |
![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
![]() ![]() ![]() |
0..1 | Expression | Criteria for group membership URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression | |
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() |
1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | |
![]() ![]() ![]() |
0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | |
![]() ![]() ![]() |
0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | |
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | |
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |
![]() ![]() ![]() |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | |
![]() ![]() ![]() |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | |
![]() ![]() ![]() |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |
![]() ![]() ![]() ![]() |
1..1 | RelatedArtifact | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | |
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Unique id | |
![]() ![]() |
0..1 | boolean | Whether this group's record is in active use | |
![]() ![]() |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person (no extensions allowed) | |
![]() ![]() |
C | 1..1 | boolean | Descriptive or actual Fixed Value: false (no extensions allowed) |
![]() ![]() |
0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | |
![]() ![]() |
1..1 | string | Label for Group | |
![]() ![]() |
0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | canonical() | Value of extension | |
![]() ![]() |
0..* | BackboneElement | Include / Exclude group members by Trait | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
![]() ![]() ![]() |
1..1 | Value held by characteristic Slice: Unordered, Closed by type:$this Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Reference(Any) | |||
![]() ![]() ![]() ![]() |
0..1 | Reference() | Value held by characteristic | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | canonical() | Instances that conform to the referenced profile URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-groupCharacteristicValueCanonical | |
![]() ![]() ![]() |
1..1 | boolean | Group includes or excludes | |
![]() ![]() |
C | 0..* | BackboneElement | Who or what is in group |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | canonical() | Value of extension Constraints: gdf-2 |
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.extension:relatedArtifact.value[x].type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | example | Not State | Unknown | |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueCodeableConcept | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueQuantity | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueRange | Base | example | Not State | 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 a characteristicExpression or characteristics, but not both |
extension('http://hl7.org/fhir/StructureDefinition/characteristicExpression').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)
|
| pub-1 | error | Group | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
Differential View
This structure is derived from CRMIGroupDefinition
| Id | Grade | Path(s) | Description | Expression |
| pub-1 | error | Group | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 1..1 | CRMIGroupDefinition | Group of multiple entities Constraints: grp-1, gdf-1, pub-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
0..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |||||
![]() ![]() ![]() |
0..1 | Expression | Criteria for group membership URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression | |||||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
![]() ![]() ![]() |
1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | |||||
![]() ![]() ![]() |
0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
![]() ![]() ![]() |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | |||||
![]() ![]() ![]() |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | |||||
![]() ![]() ![]() |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |||||
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |||||
![]() ![]() ![]() ![]() |
1..1 | RelatedArtifact | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Publication status of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus Binding: PublicationStatus (required): The lifecycle status of a reference artifact | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required): The type of relationship to the related artifact. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Short label | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Brief description of the related artifact | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | markdown | Bibliographic citation for the artifact | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Where the artifact can be accessed | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | What document is being referenced | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | canonical(Resource) | What resource is being referenced | |||||
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Unique id | |||||
![]() ![]() |
0..1 | boolean | Whether this group's record is in active use | |||||
![]() ![]() |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person (no extensions allowed) | |||||
![]() ![]() |
C | 1..1 | boolean | Descriptive or actual Fixed Value: false (no extensions allowed) | ||||
![]() ![]() |
0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | |||||
![]() ![]() |
1..1 | string | Label for Group | |||||
![]() ![]() |
0..1 | unsignedInt | Number of members | |||||
![]() ![]() |
0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | canonical() | Value of extension | |||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
![]() ![]() ![]() |
1..1 | Value held by characteristic Slice: Unordered, Closed by type:$this Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() ![]() |
0..1 | Reference() | Value held by characteristic | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | canonical() | Instances that conform to the referenced profile URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-groupCharacteristicValueCanonical | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() ![]() |
1..1 | boolean | Group includes or excludes | |||||
![]() ![]() ![]() |
0..1 | Period | Period over which characteristic is tested | |||||
![]() ![]() |
C | 0..* | BackboneElement | Who or what is in group | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reference | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-reference" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | canonical() | Value of extension Constraints: gdf-2 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() ![]() |
0..1 | Period | Period member belonged to the group | |||||
![]() ![]() ![]() |
0..1 | boolean | If member is no longer in group | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Group.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Group.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Group.extension:relatedArtifact.value[x].type | Base | required | RelatedArtifactType | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | example | Not State | Unknown | |
| Group.managingEntity.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueReference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Group.characteristic.value[x]:valueCodeableConcept | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueQuantity | Base | example | Not State | Unknown | |
| Group.characteristic.value[x]:valueRange | Base | example | Not State | 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 a characteristicExpression or characteristics, but not both |
extension('http://hl7.org/fhir/StructureDefinition/characteristicExpression').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)
|
| pub-1 | error | Group | If knowledge capabilities are stated, they SHALL include publishable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
|
This structure is derived from CRMIGroupDefinition
Summary
Mandatory: 1 element
Must-Support: 22 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron