Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot3 - STU 1 Ballot 3 World

Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

Resource Profile: StudyGroup

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/study-group Version: 1.0.0-ballot3
Standards status: Trial-use Maturity Level: 1 Computable Name: StudyGroup
Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.109

Profile of Group for Evidence Based Medicine IG. The StudyGroup Profile is used to represent an enumerated group of participants in a research study.

See Understanding the Group Resource for additional information.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* GroupR6 Group of multiple entities
Interfaces Implemented: CanonicalResource
Constraints: grp-2
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.contained 0..* Resource Contained, inline Resources
Group.Slices for extension Content/Rules for all slices
Group.Slices for extension.extension:author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Group.Slices for extension.extension:recorder 0..* ContactDetail Who entered the data
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-recorder
Group.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
Group.Slices for extension.extension:relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Group.Slices for extension.extension:characteristicExpression 0..1 Expression Criteria for group membership
URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression
Group.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
Group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Group.status This element is a modifier element. This element is included in summaries. 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Group.membership This element is included in summaries. C 0..1 code definitional | conceptual | enumerated
Binding: GroupMembershipBasis (required): The basis for membership in a group
Required Pattern: enumerated (extensions allowed)
Group.combinationMethod This element is a modifier element. This element is included in summaries. 0..1 code all-of | any-of | at-least | at-most | except-subset
Binding: GroupCharacteristicCombination (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.status Base required PublicationStatus 📍6.0.0-snapshot1 FHIR Std.
Group.membership Base required Group Membership Basis 📍6.0.0-snapshot1 FHIR Std.
Group.combinationMethod Base required Group Characteristic Combination 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
grp-2 error Group Group.type SHALL be defined if Group.membership is either 'definitional' or 'enumerated' type.exists() or (membership = 'conceptual')

This structure is derived from GroupR6

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* GroupR6 Group of multiple entities
Interfaces Implemented: CanonicalResource
Group.membership 0..1 code definitional | conceptual | enumerated
Required Pattern: enumerated (extensions allowed)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* GroupR6 Group of multiple entities
Interfaces Implemented: CanonicalResource
Constraints: grp-2
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Group.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
Group.contained 0..* Resource Contained, inline Resources
Group.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.Slices for extension.extension:author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Group.Slices for extension.extension:recorder 0..* ContactDetail Who entered the data
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-recorder
Group.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
Group.Slices for extension.extension:relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Group.Slices for extension.extension:characteristicExpression 0..1 Expression Criteria for group membership
URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression
Group.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
Group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Group.url This element is included in summaries. C 0..1 uri Canonical identifier for this Group, represented as an absolute URI (globally unique)
Constraints: cnl-1
Group.identifier This element is included in summaries. 0..* Identifier Business Identifier for this Group
Group.version This element is included in summaries. 0..1 string Business version of the Group
Group.versionAlgorithm[x] This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
Group.versionAlgorithm[x].versionAlgorithmString string
Group.versionAlgorithm[x].versionAlgorithmCoding Coding
Group.name This element is included in summaries. 0..1 string Label for Group
Group.title This element is included in summaries. 0..1 string Name for this Group (human friendly)
Group.status This element is a modifier element. This element is included in summaries. 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Group.experimental This element is included in summaries. 0..1 boolean For testing only - never for real usage
Group.date This element is included in summaries. 0..1 dateTime Date last changed
Group.publisher This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
Group.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Group.description 0..1 markdown Natural language description of the group
Group.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Group.purpose 0..1 markdown Why this Group is defined
Group.copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
Group.copyrightLabel 0..1 string Copyright holder and year(s)
Group.type This element is included in summaries. C 0..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen | medication | medicinalproductdefinition | substance | substancedefinition | biologicallyDerivedProduct | nutritionProduct
Binding: GroupType (required): Types of resources that are part of group.
Group.membership This element is included in summaries. C 0..1 code definitional | conceptual | enumerated
Binding: GroupMembershipBasis (required): The basis for membership in a group
Required Pattern: enumerated (extensions allowed)
Group.code This element is included in summaries. 0..1 CodeableConcept Use of the Group (and by implication, kind of members)
Binding: GroupCode (extensible): A code that describes the kind of group, which usually dictates what kind if entities can be in the group.
Group.quantity This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element is included in summaries. 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
Group.combinationMethod This element is a modifier element. This element is included in summaries. 0..1 code all-of | any-of | at-least | at-most | except-subset
Binding: GroupCharacteristicCombination (required)
Group.combinationThreshold 0..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used
Group.characteristic This element is included in summaries. 0..* BackboneElement Include / Exclude group members by Trait
Group.characteristic.id 0..1 string Unique id for inter-element referencing
Group.characteristic.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.characteristic.Slices for extension.extension:relevantForAutomatedMatching 0..1 boolean Relevant for automated matching
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/relevant-for-automated-matching
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Group.characteristic.code This element is included in summaries. 1..1 CodeableConcept Kind of characteristic
Binding: ExampleCharacteristicCodes (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Group.characteristic.value[x] This element is included in summaries. 1..1 Value held by characteristic
Group.characteristic.value[x].valueCodeableConcept CodeableConcept
Group.characteristic.value[x].valueBoolean boolean
Group.characteristic.value[x].valueQuantity Quantity
Group.characteristic.value[x].valueRange Range
Group.characteristic.value[x].valueReference Reference(Any)
Group.characteristic.value[x].valueUri uri
Group.characteristic.value[x].valueExpression Expression
Group.characteristic.exclude This element is included in summaries. 1..1 boolean Group includes or excludes
Group.characteristic.description 0..1 markdown Natural language description of the characteristic
Group.characteristic.method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: DefinitionMethod (example)
Group.characteristic.formula 0..1 Expression Formal algorithm to derive the value
Group.characteristic.determiner 0..1 Reference(Practitioner | PractitionerRole | Organization | Device | DeviceDefinition) Who determines the value
Group.characteristic.offset This element is a modifier element. This element is included in summaries. 0..1 CodeableConcept Reference point for comparison
Binding: CharacteristicOffset (example)
Group.characteristic.instances[x] C 0..1 Number of occurrences
Constraints: grp-1
Group.characteristic.instances[x].instancesUnsignedInt unsignedInt
Group.characteristic.instances[x].instancesRange Range
Group.characteristic.duration[x] 0..1 How long
Group.characteristic.duration[x].durationDuration Duration
Group.characteristic.duration[x].durationRange Range
Group.characteristic.period 0..1 Period When (in calendar time)
Group.characteristic.relativeTime 0..* RelativeTime When (with respect to an event)
Group.member 0..* BackboneElement Who or what is in group
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Group.member.entity 1..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen | Medication | MedicinalProductDefinition | Substance | SubstanceDefinition | BiologicallyDerivedProduct | NutritionProduct) Reference to the group member
Group.member.involvement 0..* CodeableConcept Code that describes how user is part of the group
Binding: GroupInvolvement (example): A code that describes how a user is involved in the group
Group.member.period 0..1 Period Period member belonged to the group
Group.member.inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.
Group.versionAlgorithm[x] Base extensible Version Algorithm 📍6.0.0-snapshot1 FHIR Std.
Group.status Base required PublicationStatus 📍6.0.0-snapshot1 FHIR Std.
Group.type Base required Group Type 📍6.0.0-snapshot1 FHIR Std.
Group.membership Base required Group Membership Basis 📍6.0.0-snapshot1 FHIR Std.
Group.code Base extensible Group Code 📍6.0.0-snapshot1 FHIR Std.
Group.combinationMethod Base required Group Characteristic Combination 📍6.0.0-snapshot1 FHIR Std.
Group.characteristic.​code Base example Example Characteristic Codes 📍6.0.0-snapshot1 FHIR Std.
Group.characteristic.​method Base example Definition Method 📍6.0.0-snapshot1 FHIR Std.
Group.characteristic.​offset Base example Characteristic Offset 📍6.0.0-snapshot1 FHIR Std.
Group.member.involvement Base example Group Involvement 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-1 warning Group.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
grp-1 error Group.characteristic.instances[x] Ranges have to be positive ($this is Range) implies ((low.empty() or ((low.code.exists() or low.value.empty()) and (low.system.empty() or low.system = %ucum) and (low.code.empty() or low.code = '1') and (low.value.empty() or low.value.hasValue().not() or low.value.toString().contains('.').not()) and (low.value.empty() or low.value.hasValue().not() or low.value >= 0))) and (high.empty() or ((high.code.exists() or high.value.empty()) and (high.system.empty() or high.system = %ucum) and (high.code.empty() or high.code = '1') and (high.value.empty() or high.value.hasValue().not() or high.value.toString().contains('.').not()) and (high.value.empty() or high.value.hasValue().not() or high.value >= 0))))
grp-2 error Group Group.type SHALL be defined if Group.membership is either 'definitional' or 'enumerated' type.exists() or (membership = 'conceptual')

This structure is derived from GroupR6

Summary

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* GroupR6 Group of multiple entities
Interfaces Implemented: CanonicalResource
Constraints: grp-2
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.contained 0..* Resource Contained, inline Resources
Group.Slices for extension Content/Rules for all slices
Group.Slices for extension.extension:author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Group.Slices for extension.extension:recorder 0..* ContactDetail Who entered the data
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-recorder
Group.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
Group.Slices for extension.extension:relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Group.Slices for extension.extension:characteristicExpression 0..1 Expression Criteria for group membership
URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression
Group.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
Group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Group.status This element is a modifier element. This element is included in summaries. 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Group.membership This element is included in summaries. C 0..1 code definitional | conceptual | enumerated
Binding: GroupMembershipBasis (required): The basis for membership in a group
Required Pattern: enumerated (extensions allowed)
Group.combinationMethod This element is a modifier element. This element is included in summaries. 0..1 code all-of | any-of | at-least | at-most | except-subset
Binding: GroupCharacteristicCombination (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.status Base required PublicationStatus 📍6.0.0-snapshot1 FHIR Std.
Group.membership Base required Group Membership Basis 📍6.0.0-snapshot1 FHIR Std.
Group.combinationMethod Base required Group Characteristic Combination 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
grp-2 error Group Group.type SHALL be defined if Group.membership is either 'definitional' or 'enumerated' type.exists() or (membership = 'conceptual')

Differential View

This structure is derived from GroupR6

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* GroupR6 Group of multiple entities
Interfaces Implemented: CanonicalResource
Group.membership 0..1 code definitional | conceptual | enumerated
Required Pattern: enumerated (extensions allowed)

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* GroupR6 Group of multiple entities
Interfaces Implemented: CanonicalResource
Constraints: grp-2
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Group.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
Group.contained 0..* Resource Contained, inline Resources
Group.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.Slices for extension.extension:author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Group.Slices for extension.extension:recorder 0..* ContactDetail Who entered the data
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-recorder
Group.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
Group.Slices for extension.extension:relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Group.Slices for extension.extension:characteristicExpression 0..1 Expression Criteria for group membership
URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression
Group.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
Group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Group.url This element is included in summaries. C 0..1 uri Canonical identifier for this Group, represented as an absolute URI (globally unique)
Constraints: cnl-1
Group.identifier This element is included in summaries. 0..* Identifier Business Identifier for this Group
Group.version This element is included in summaries. 0..1 string Business version of the Group
Group.versionAlgorithm[x] This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
Group.versionAlgorithm[x].versionAlgorithmString string
Group.versionAlgorithm[x].versionAlgorithmCoding Coding
Group.name This element is included in summaries. 0..1 string Label for Group
Group.title This element is included in summaries. 0..1 string Name for this Group (human friendly)
Group.status This element is a modifier element. This element is included in summaries. 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Group.experimental This element is included in summaries. 0..1 boolean For testing only - never for real usage
Group.date This element is included in summaries. 0..1 dateTime Date last changed
Group.publisher This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
Group.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Group.description 0..1 markdown Natural language description of the group
Group.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Group.purpose 0..1 markdown Why this Group is defined
Group.copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
Group.copyrightLabel 0..1 string Copyright holder and year(s)
Group.type This element is included in summaries. C 0..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen | medication | medicinalproductdefinition | substance | substancedefinition | biologicallyDerivedProduct | nutritionProduct
Binding: GroupType (required): Types of resources that are part of group.
Group.membership This element is included in summaries. C 0..1 code definitional | conceptual | enumerated
Binding: GroupMembershipBasis (required): The basis for membership in a group
Required Pattern: enumerated (extensions allowed)
Group.code This element is included in summaries. 0..1 CodeableConcept Use of the Group (and by implication, kind of members)
Binding: GroupCode (extensible): A code that describes the kind of group, which usually dictates what kind if entities can be in the group.
Group.quantity This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element is included in summaries. 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
Group.combinationMethod This element is a modifier element. This element is included in summaries. 0..1 code all-of | any-of | at-least | at-most | except-subset
Binding: GroupCharacteristicCombination (required)
Group.combinationThreshold 0..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used
Group.characteristic This element is included in summaries. 0..* BackboneElement Include / Exclude group members by Trait
Group.characteristic.id 0..1 string Unique id for inter-element referencing
Group.characteristic.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.characteristic.Slices for extension.extension:relevantForAutomatedMatching 0..1 boolean Relevant for automated matching
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/relevant-for-automated-matching
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Group.characteristic.code This element is included in summaries. 1..1 CodeableConcept Kind of characteristic
Binding: ExampleCharacteristicCodes (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Group.characteristic.value[x] This element is included in summaries. 1..1 Value held by characteristic
Group.characteristic.value[x].valueCodeableConcept CodeableConcept
Group.characteristic.value[x].valueBoolean boolean
Group.characteristic.value[x].valueQuantity Quantity
Group.characteristic.value[x].valueRange Range
Group.characteristic.value[x].valueReference Reference(Any)
Group.characteristic.value[x].valueUri uri
Group.characteristic.value[x].valueExpression Expression
Group.characteristic.exclude This element is included in summaries. 1..1 boolean Group includes or excludes
Group.characteristic.description 0..1 markdown Natural language description of the characteristic
Group.characteristic.method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: DefinitionMethod (example)
Group.characteristic.formula 0..1 Expression Formal algorithm to derive the value
Group.characteristic.determiner 0..1 Reference(Practitioner | PractitionerRole | Organization | Device | DeviceDefinition) Who determines the value
Group.characteristic.offset This element is a modifier element. This element is included in summaries. 0..1 CodeableConcept Reference point for comparison
Binding: CharacteristicOffset (example)
Group.characteristic.instances[x] C 0..1 Number of occurrences
Constraints: grp-1
Group.characteristic.instances[x].instancesUnsignedInt unsignedInt
Group.characteristic.instances[x].instancesRange Range
Group.characteristic.duration[x] 0..1 How long
Group.characteristic.duration[x].durationDuration Duration
Group.characteristic.duration[x].durationRange Range
Group.characteristic.period 0..1 Period When (in calendar time)
Group.characteristic.relativeTime 0..* RelativeTime When (with respect to an event)
Group.member 0..* BackboneElement Who or what is in group
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Group.member.entity 1..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen | Medication | MedicinalProductDefinition | Substance | SubstanceDefinition | BiologicallyDerivedProduct | NutritionProduct) Reference to the group member
Group.member.involvement 0..* CodeableConcept Code that describes how user is part of the group
Binding: GroupInvolvement (example): A code that describes how a user is involved in the group
Group.member.period 0..1 Period Period member belonged to the group
Group.member.inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.
Group.versionAlgorithm[x] Base extensible Version Algorithm 📍6.0.0-snapshot1 FHIR Std.
Group.status Base required PublicationStatus 📍6.0.0-snapshot1 FHIR Std.
Group.type Base required Group Type 📍6.0.0-snapshot1 FHIR Std.
Group.membership Base required Group Membership Basis 📍6.0.0-snapshot1 FHIR Std.
Group.code Base extensible Group Code 📍6.0.0-snapshot1 FHIR Std.
Group.combinationMethod Base required Group Characteristic Combination 📍6.0.0-snapshot1 FHIR Std.
Group.characteristic.​code Base example Example Characteristic Codes 📍6.0.0-snapshot1 FHIR Std.
Group.characteristic.​method Base example Definition Method 📍6.0.0-snapshot1 FHIR Std.
Group.characteristic.​offset Base example Characteristic Offset 📍6.0.0-snapshot1 FHIR Std.
Group.member.involvement Base example Group Involvement 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-1 warning Group.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
grp-1 error Group.characteristic.instances[x] Ranges have to be positive ($this is Range) implies ((low.empty() or ((low.code.exists() or low.value.empty()) and (low.system.empty() or low.system = %ucum) and (low.code.empty() or low.code = '1') and (low.value.empty() or low.value.hasValue().not() or low.value.toString().contains('.').not()) and (low.value.empty() or low.value.hasValue().not() or low.value >= 0))) and (high.empty() or ((high.code.exists() or high.value.empty()) and (high.system.empty() or high.system = %ucum) and (high.code.empty() or high.code = '1') and (high.value.empty() or high.value.hasValue().not() or high.value.toString().contains('.').not()) and (high.value.empty() or high.value.hasValue().not() or high.value >= 0))))
grp-2 error Group Group.type SHALL be defined if Group.membership is either 'definitional' or 'enumerated' type.exists() or (membership = 'conceptual')

This structure is derived from GroupR6

Summary

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

See Understanding the Group Resource for additional information. An example from the QUARTET USA trial will be described here and can be viewed at Enrolled Group for QUARTET USA Trial.

The concepts needed to describe the enrolled group for the QUARTET USA trial include:

  1. The group is an ‘actual’ group of people.
  2. The group has 62 members.
  3. The group membership criteria is defined in a Group Resource named Eligibility Criteria for QUARTET USA Trial.

We start by creating a FHIR Group Resource with a StudyGroup Profile. This instance of Group Resource is being used to define the actual group, either with a quantity or a list of members, therefore the Group.membership element has a value of “enumerated”. For an enumerated Group, a Group.type element is required, and the Group.type element has a value of “person”.

The Group.quantity element has an unsignedInt datatype (allowing integer values without a negative sign) because it is for a simple count of group members. The Group.quantity element has a value of 62 in this example.

The definition of group membership is described in a single characteristic, so there is no Group.combinationMethod element. Because this single characteristic is defined fully in a different Group Resource, we use the Group.characteristic.valueReference element to reference it, and the Group.characteristic.code element describes its role as the value of the “Eligibility Criteria”.

"characteristic" : [
  {
    "code" : {
      "text" : "Eligibility Criteria"
    },
    "valueReference" : {
      "reference" : "Group/372778",
      "type" : "Group",
      "display" : "Eligibility Criteria for QUARTET USA Trial"
    },
    "exclude" : false
  }
]