FHIR Clinical Guidelines (v1.0.0) (STU1)

Clinical Practice Guidelines, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

D.4.1 StructureDefinition-cpg-group

Introduction:

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-group

Defines an actual group of subjects, suitable for use in various contexts, such as a enrollment in a pathway or participant in a study

This profile builds on Group.

This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 1 element
Must-Support: 10 elements
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of multiple entities
... identifier S0..*IdentifierUnique id
... active S0..1booleanWhether this group's record is in active use
... type S1..1codeperson | animal | practitioner | device | medication | substance
Fixed Value: person
... actual S1..1booleanDescriptive or actual
Fixed Value: true
... code S0..1CodeableConceptKind of Group members
... name S1..1stringLabel for Group
... characteristic 0..0
... member S0..*BackboneElementWho or what is in group
.... entity S1..1Reference(CPGPatient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*GroupGroup of multiple entities
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique id
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣI1..1booleanDescriptive or actual
Fixed Value: true
... code SΣ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ1..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... member SI0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(CPGPatient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format

Summary

Mandatory: 1 element
Must-Support: 10 elements
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of multiple entities
... identifier S0..*IdentifierUnique id
... active S0..1booleanWhether this group's record is in active use
... type S1..1codeperson | animal | practitioner | device | medication | substance
Fixed Value: person
... actual S1..1booleanDescriptive or actual
Fixed Value: true
... code S0..1CodeableConceptKind of Group members
... name S1..1stringLabel for Group
... characteristic 0..0
... member S0..*BackboneElementWho or what is in group
.... entity S1..1Reference(CPGPatient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*GroupGroup of multiple entities
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique id
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣI1..1booleanDescriptive or actual
Fixed Value: true
... code SΣ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ1..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... member SI0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(CPGPatient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Group.languagepreferredCommonLanguages
Max Binding: AllLanguages
Group.typerequiredFixed Value: person
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2GroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3GroupIf 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-4GroupIf 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-5GroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6GroupA resource should have narrative for robust management
: text.`div`.exists()
grp-1GroupCan only have members if group is "actual"
: member.empty() or (actual = true)
ele-1Group.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.actualAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.quantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.managingEntityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.characteristic.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.characteristic.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.characteristic.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.characteristic.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.characteristic.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.characteristic.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.characteristic.excludeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.characteristic.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.memberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.member.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.member.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.member.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.member.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.member.entityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.member.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.member.inactiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())