This page is part of the Evidence Based Medicine on FHIR Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/study-group | Version: 1.0.0-ballot | |||
Standards status: Draft | Maturity Level: 1 | Computable Name: StudyGroup |
Profile of Group for Evidence Based Medicine IG. The StudyGroup Profile is used to represent an enumerated group of participants in a research study.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from GroupR6
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | GroupR6 | |||
membership | 1..1 | code | definitional | enumerated Required Pattern: enumerated | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Group.type | required | GroupType |
Group.membership | required | Pattern: enumerated |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Group | 0..* | GroupR6 | Group of multiple entities | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
url | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |||||
version | 0..1 | string | Business version of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-version | |||||
versionAlgorithmString | 0..1 | string | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-version profiled by http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |||||
title | 0..1 | string | Name for this {{title}} (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |||||
experimental | 0..1 | boolean | For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental | |||||
date | 0..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | |||||
publisher | 0..1 | string | Name of the publisher/steward (organization or individual) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher | |||||
contact | 0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | |||||
useContext | 0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | |||||
purpose | 0..1 | markdown | Why this {{title}} is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
author | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |||||
characteristicExpression | 0..1 | Expression | Criteria for group membership URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression | |||||
combinationMethod | 0..1 | code | all-of | any-of | at-least | at-most | except-subset URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/combination-method | |||||
combinationThreshold | 0..1 | positiveInt | Provides the value of n when at-least or at-most codes are used URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/combination-threshold | |||||
Slices for modifierExtension | ?!Σ | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:status | ?! | 0..1 | ArtifactStatus | draft | active | retired | unknown | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for this Group | ||||
active | ?!Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
type | Σ | 1..1 | code | person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen Binding: GroupType (required): Types of resources that are part of group. | ||||
membership | Σ | 1..1 | code | definitional | enumerated Binding: GroupMembershipBasis (required): The basis for membership in a group Required Pattern: enumerated | ||||
code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
name | Σ | 0..1 | string | Label for Group | ||||
description | 0..1 | markdown | Natural language description of the group | |||||
quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
characteristic | Σ | 0..* | BackboneElement | Include / Exclude group members by Trait | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
valueUri | 0..1 | uri | Value held by uri URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-value-uri | |||||
valueExpression | 0..1 | Expression | Value held by Expression URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-value-expression | |||||
description | 0..1 | markdown | Natural language description of the characteristic URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-description | |||||
method | 0..* | CodeableConcept | Method for how the characteristic value was determined URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-method | |||||
determinedByReference | 0..1 | Reference(Device | DeviceDefinition | DeviceMetric) | Method for how the characteristic value was determined URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-determined-by-reference | |||||
determinedByExpression | 0..1 | Expression | Method for how the characteristic value was determined URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-determined-by-expression | |||||
offset | 0..1 | CodeableConcept | Reference point for comparison URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-offset | |||||
instancesQuantity | 0..1 | Quantity | Number of occurrences meeting the characteristic URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-instances-quantity | |||||
instancesRange | 0..1 | Range | Number of occurrences meeting the characteristic URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-instances-range | |||||
durationDuration | 0..1 | Duration | Length of time in which the characteristic is met URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-duration-duration | |||||
durationRange | 0..1 | Range | Length of time in which the characteristic is met URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-duration-range | |||||
timing | 0..* | (Complex) | Timing in which the characteristic is determined URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | ||||
value[x] | Σ | 1..1 | Value held by characteristic Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueBoolean | boolean | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference(Any) | |||||||
exclude | Σ | 1..1 | boolean | Group includes or excludes | ||||
period | 0..1 | Period | Period over which characteristic is tested | |||||
member | 0..* | BackboneElement | Who or what is in group | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entity | 1..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) | Reference to the group member | |||||
period | 0..1 | Period | Period member belonged to the group | |||||
inactive | 0..1 | boolean | If member is no longer in group | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Group.language | required | AllLanguages |
Group.type | required | GroupType |
Group.membership | required | Pattern: enumerated |
Group.code | example | |
Group.characteristic.code | example | |
Group.characteristic.value[x] | example |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Differential View
This structure is derived from GroupR6
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | GroupR6 | |||
membership | 1..1 | code | definitional | enumerated Required Pattern: enumerated | |
Documentation for this format |
Key Elements View
Path | Conformance | ValueSet / Code |
Group.type | required | GroupType |
Group.membership | required | Pattern: enumerated |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Group | 0..* | GroupR6 | Group of multiple entities | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
url | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |||||
version | 0..1 | string | Business version of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-version | |||||
versionAlgorithmString | 0..1 | string | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-version profiled by http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |||||
title | 0..1 | string | Name for this {{title}} (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |||||
experimental | 0..1 | boolean | For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental | |||||
date | 0..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | |||||
publisher | 0..1 | string | Name of the publisher/steward (organization or individual) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher | |||||
contact | 0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | |||||
useContext | 0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | |||||
purpose | 0..1 | markdown | Why this {{title}} is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
author | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |||||
characteristicExpression | 0..1 | Expression | Criteria for group membership URL: http://hl7.org/fhir/StructureDefinition/characteristicExpression | |||||
combinationMethod | 0..1 | code | all-of | any-of | at-least | at-most | except-subset URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/combination-method | |||||
combinationThreshold | 0..1 | positiveInt | Provides the value of n when at-least or at-most codes are used URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/combination-threshold | |||||
Slices for modifierExtension | ?!Σ | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:status | ?! | 0..1 | ArtifactStatus | draft | active | retired | unknown | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for this Group | ||||
active | ?!Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
type | Σ | 1..1 | code | person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen Binding: GroupType (required): Types of resources that are part of group. | ||||
membership | Σ | 1..1 | code | definitional | enumerated Binding: GroupMembershipBasis (required): The basis for membership in a group Required Pattern: enumerated | ||||
code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
name | Σ | 0..1 | string | Label for Group | ||||
description | 0..1 | markdown | Natural language description of the group | |||||
quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
characteristic | Σ | 0..* | BackboneElement | Include / Exclude group members by Trait | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
valueUri | 0..1 | uri | Value held by uri URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-value-uri | |||||
valueExpression | 0..1 | Expression | Value held by Expression URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-value-expression | |||||
description | 0..1 | markdown | Natural language description of the characteristic URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-description | |||||
method | 0..* | CodeableConcept | Method for how the characteristic value was determined URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-method | |||||
determinedByReference | 0..1 | Reference(Device | DeviceDefinition | DeviceMetric) | Method for how the characteristic value was determined URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-determined-by-reference | |||||
determinedByExpression | 0..1 | Expression | Method for how the characteristic value was determined URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-determined-by-expression | |||||
offset | 0..1 | CodeableConcept | Reference point for comparison URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-offset | |||||
instancesQuantity | 0..1 | Quantity | Number of occurrences meeting the characteristic URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-instances-quantity | |||||
instancesRange | 0..1 | Range | Number of occurrences meeting the characteristic URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-instances-range | |||||
durationDuration | 0..1 | Duration | Length of time in which the characteristic is met URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-duration-duration | |||||
durationRange | 0..1 | Range | Length of time in which the characteristic is met URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-duration-range | |||||
timing | 0..* | (Complex) | Timing in which the characteristic is determined URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | ||||
value[x] | Σ | 1..1 | Value held by characteristic Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueBoolean | boolean | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference(Any) | |||||||
exclude | Σ | 1..1 | boolean | Group includes or excludes | ||||
period | 0..1 | Period | Period over which characteristic is tested | |||||
member | 0..* | BackboneElement | Who or what is in group | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entity | 1..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) | Reference to the group member | |||||
period | 0..1 | Period | Period member belonged to the group | |||||
inactive | 0..1 | boolean | If member is no longer in group | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Group.language | required | AllLanguages |
Group.type | required | GroupType |
Group.membership | required | Pattern: enumerated |
Group.code | example | |
Group.characteristic.code | example | |
Group.characteristic.value[x] | example |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Other representations of profile: CSV, Excel, Schematron