Making EHR Data More available for Research and Public Health (MedMorph)
0.2.0 - STU 1 draft
Making EHR Data More available for Research and Public Health (MedMorph)
0.2.0 - STU 1 draft
This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) (v0.2.0: STU 1 Draft) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/medmorph/StructureDefinition/research-participant-group |
| Version: | 0.2.0 |
| Name: | ResearchParticipantGroup |
| Title: | Research Participant Group |
| Status: | Draft as of 9/1/19 |
| Definition: | Group Resource profile for specifying survey participant groups, research groups. |
| Publisher: | HL7 International - Public Health Work Group |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/medmorph/StructureDefinition/research-participant-group
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Group
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Group | 0..* | Group | Research Participant Group | |
  meta | ||||
  lastUpdated | S | 1..1 | instant | When the resource version last changed |
 active | S | 0..1 | boolean | Whether this group's record is in active use |
 type | S | 1..1 | code | person | animal | practitioner | device | medication | substance Fixed Value: person |
| actual | S | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| name | S | 0..1 | string | Label for Group |
 managingEntity | S | 1..1 | Reference(US Core Organization Profile) | Entity that is the custodian of the Group's definition |
 member | S | 0..* | BackboneElement | Who or what is in group |
 entity | S | 1..1 | Reference(US Core Patient Profile) | Reference to the group member |
| period | S | 0..1 | Period | Period member belonged to the group |
| inactive | S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | I | 0..* | Group | Research Participant Group |
| id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
 Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | SΣ | 1..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | Σ | 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". |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Unique id |
| active | SΣ | 0..1 | boolean | Whether this group's record is in active use |
| type | SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual | SΣI | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
| name | SΣ | 0..1 | string | Label for Group |
| quantity | Σ | 0..1 | unsignedInt | Number of members |
| managingEntity | SΣ | 1..1 | Reference(US Core Organization Profile) | 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 | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| 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 | SI | 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 | S | 1..1 | Reference(US Core Patient Profile) | Reference to the group member |
| period | S | 0..1 | Period | Period member belonged to the group |
| inactive | S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | I | 0..* | Group | Research Participant Group |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed |
| active | Σ | 0..1 | boolean | Whether this group's record is in active use |
| type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual | ΣI | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| name | Σ | 0..1 | string | Label for Group |
| managingEntity | Σ | 1..1 | Reference(US Core Organization Profile) | Entity that is the custodian of the Group's definition |
| member | I | 0..* | BackboneElement | Who or what is in group |
| entity | 1..1 | Reference(US Core Patient Profile) | 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 | ||||
This structure is derived from Group
Differential View
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | 0..* | Group | Research Participant Group | |
| meta | ||||
| lastUpdated | S | 1..1 | instant | When the resource version last changed |
| active | S | 0..1 | boolean | Whether this group's record is in active use |
| type | S | 1..1 | code | person | animal | practitioner | device | medication | substance Fixed Value: person |
| actual | S | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| name | S | 0..1 | string | Label for Group |
| managingEntity | S | 1..1 | Reference(US Core Organization Profile) | Entity that is the custodian of the Group's definition |
| member | S | 0..* | BackboneElement | Who or what is in group |
| entity | S | 1..1 | Reference(US Core Patient Profile) | Reference to the group member |
| period | S | 0..1 | Period | Period member belonged to the group |
| inactive | S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | I | 0..* | Group | Research Participant Group |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | SΣ | 1..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | Σ | 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". |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Unique id |
| active | SΣ | 0..1 | boolean | Whether this group's record is in active use |
| type | SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual | SΣI | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
| name | SΣ | 0..1 | string | Label for Group |
| quantity | Σ | 0..1 | unsignedInt | Number of members |
| managingEntity | SΣ | 1..1 | Reference(US Core Organization Profile) | 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 | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| 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 | SI | 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 | S | 1..1 | Reference(US Core Patient Profile) | Reference to the group member |
| period | S | 0..1 | Period | Period member belonged to the group |
| inactive | S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Group.meta.security | extensible | All Security Labels |
| Group.meta.tag | example | CommonTags |
| Group.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Group.type | required | Fixed Value: person |
| Group.code | example | |
| Group.characteristic.code | example | |
| Group.characteristic.value[x] | example |
| Id | Path | Details | Requirements |
| dom-2 | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Group | A resource should have narrative for robust management : text.`div`.exists() | |
| grp-1 | Group | Can only have members if group is "actual" : member.empty() or (actual = true) | |
| ele-1 | Group.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.meta.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.meta.versionId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.lastUpdated | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.profile | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.security | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.tag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.actual | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.managingEntity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.characteristic.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.characteristic.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.characteristic.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.characteristic.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic.exclude | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.member | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.member.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.member.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.member.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.member.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.member.entity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.member.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.member.inactive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Public Health Work Group. Package hl7.fhir.us.medmorph#0.2.0 based on FHIR 4.0.1. Generated 2021-12-08
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change