OpenMRS Core FHIR Implementation Guide
0.1.0 - ci-build
OpenMRS Core FHIR Implementation Guide
0.1.0 - ci-build
OpenMRS Core FHIR Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Official URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-group | Version: 0.1.0 | |||
| Active as of 2023-06-23 | Computable Name: OMRSGroup | |||
A Group Resource is described as Cohort in Fhir2 OMRS
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Group | 0..* | Group | Group of multiple entities | |
  id | 1..1 | id | Logical id of this artifact | |
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 description | 1..1 | string | Group descriptive extension URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext | |
| active | 1..1 | boolean | Whether this group's record is in active use | |
| type | 1..1 | code | person | animal | practitioner | device | medication | substance | |
| name | 1..1 | string | Label for Group | |
  managingEntity | 0..1 | Reference(Openmrs Practitioner) | Entity that is the custodian of the Group's definition | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | C | 0..* | Group | Group of multiple entities |
 id | Σ | 1..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| description | 1..1 | string | Group descriptive extension URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| active | Σ | 1..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. |
| actual | ΣC | 1..1 | boolean | Descriptive or actual |
| name | Σ | 1..1 | string | Label for Group |
| managingEntity | Σ | 0..1 | Reference(Openmrs Practitioner) | Entity that is the custodian of the Group's definition |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Group.type | required | GroupType |
| 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().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 | 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() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Group | C | 0..* | Group | Group of multiple entities | ||||
| id | Σ | 1..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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| description | 1..1 | string | Group descriptive extension URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique id | ||||
| active | Σ | 1..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. | ||||
| actual | ΣC | 1..1 | boolean | Descriptive or actual | ||||
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name | Σ | 1..1 | string | Label for Group | ||||
| quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity | Σ | 0..1 | Reference(Openmrs Practitioner) | 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 | C | 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(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | 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 | ||||
| Group.language | preferred | CommonLanguages
| ||||
| Group.type | required | GroupType | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from Group
Differential View
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | 0..* | Group | Group of multiple entities | |
| id | 1..1 | id | Logical id of this artifact | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| description | 1..1 | string | Group descriptive extension URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext | |
| active | 1..1 | boolean | Whether this group's record is in active use | |
| type | 1..1 | code | person | animal | practitioner | device | medication | substance | |
| name | 1..1 | string | Label for Group | |
| managingEntity | 0..1 | Reference(Openmrs Practitioner) | Entity that is the custodian of the Group's definition | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | C | 0..* | Group | Group of multiple entities |
| id | Σ | 1..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| description | 1..1 | string | Group descriptive extension URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| active | Σ | 1..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. |
| actual | ΣC | 1..1 | boolean | Descriptive or actual |
| name | Σ | 1..1 | string | Label for Group |
| managingEntity | Σ | 0..1 | Reference(Openmrs Practitioner) | Entity that is the custodian of the Group's definition |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Group.type | required | GroupType |
| 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().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 | 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() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Group | C | 0..* | Group | Group of multiple entities | ||||
| id | Σ | 1..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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| description | 1..1 | string | Group descriptive extension URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique id | ||||
| active | Σ | 1..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. | ||||
| actual | ΣC | 1..1 | boolean | Descriptive or actual | ||||
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name | Σ | 1..1 | string | Label for Group | ||||
| quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity | Σ | 0..1 | Reference(Openmrs Practitioner) | 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 | C | 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(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | 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 | ||||
| Group.language | preferred | CommonLanguages
| ||||
| Group.type | required | GroupType | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from Group
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ . Package openmrs.fhir.core#0.1.0 based on FHIR 4.0.1. Generated 2023-06-23
Links: Table of Contents |
QA Report |
Version History |
|