SMART Base
0.2.0 - ci-build

This page is part of the SMART Base (v0.2.0: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: SMART Guidelines Group Definition

Official URL: http://smart.who.int/base/StructureDefinition/SGGroupDefinition Version: 0.2.0
Draft as of 2025-04-02 Computable Name: SGGroupDefinition

WHO SMART Guidelines Group Definition

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* CRMIGroupDefinition Group of multiple entities
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
grp-1: Can only have members if group is "actual"
gdf-1: Group definition must have either an expression or characteristics, but not both
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:library S 0..1 canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:expression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active SΣ 1..1 boolean Whether this group's record is in active use
ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


ele-1: All FHIR elements must have a @value or children
Fixed Value: person
... actual SΣC 1..1 boolean Descriptive or actual
ele-1: All FHIR elements must have a @value or children
Fixed Value: false
... code SΣ 0..1 CodeableConcept Kind of Group members
Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc.


ele-1: All FHIR elements must have a @value or children
... name SΣ 1..1 string Label for Group
ele-1: All FHIR elements must have a @value or children
... managingEntity Σ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:profile S 0..1 canonical() The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... characteristic S 0..* BackboneElement Include / Exclude group members by Trait
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
.... value[x] 1..1 Value held by characteristic
Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.


ele-1: All FHIR elements must have a @value or children
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
... member C 0..* BackboneElement Who or what is in group
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... entity 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:profile S 0..1 (Complex) The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"
....... value[x] C 1..1 canonical() Value of extension
ele-1: All FHIR elements must have a @value or children
gdf-2: Reference must be to a structure definition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gdf-1errorGroupGroup definition must have either an expression or characteristics, but not both
: extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists()
gdf-2errorGroup.member.entity.extension:profile.value[x]Reference must be to a structure definition
: resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition')
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)

 

Other representations of profile: CSV, Excel, Schematron