OpenMRS Core FHIR Implementation Guide, published by . This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/abertnamanya/openmrs-contrib-fhir2-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: OMRS Group

A Group Resource is described as Cohort in Fhir2 OMRS

Usage:

• Examples for this Resource Profile: male cohort

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management grp-1: Can only have members if group is "actual"
id	Σ	1..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
description		1..1	string	Group descriptive extension URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	Σ	1..1	boolean	Whether this group's record is in active use ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. ele-1: All FHIR elements must have a @value or children
actual	ΣC	1..1	boolean	Descriptive or actual ele-1: All FHIR elements must have a @value or children
name	Σ	1..1	string	Label for Group ele-1: All FHIR elements must have a @value or children
managingEntity	Σ	0..1	Reference(Openmrs Practitioner)	Entity that is the custodian of the Group's definition ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Group.type	required	GroupType http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard

Constraints

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 grp-1: Can only have members if group is "actual"
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. Additional Bindings Purpose AllLanguages Max Binding
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 Description (No ValueSet): (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 Description (No ValueSet): (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 Description (No ValueSet): (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

Terminology Bindings

Path	Conformance	ValueSet	URI
Group.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Group.type	required	GroupType http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.code	example
Group.characteristic.code	example
Group.characteristic.value[x]	example

Constraints

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)

This structure is derived from Group

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

• Openmrs Practitioner (http://fhir.openmrs.org/core/StructureDefinition/omrs-practitioner)

Extensions

This structure refers to these extensions:

• http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext

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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management grp-1: Can only have members if group is "actual"
id	Σ	1..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
description		1..1	string	Group descriptive extension URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	Σ	1..1	boolean	Whether this group's record is in active use ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. ele-1: All FHIR elements must have a @value or children
actual	ΣC	1..1	boolean	Descriptive or actual ele-1: All FHIR elements must have a @value or children
name	Σ	1..1	string	Label for Group ele-1: All FHIR elements must have a @value or children
managingEntity	Σ	0..1	Reference(Openmrs Practitioner)	Entity that is the custodian of the Group's definition ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Group.type	required	GroupType http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard

Constraints

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 grp-1: Can only have members if group is "actual"
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. Additional Bindings Purpose AllLanguages Max Binding
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 Description (No ValueSet): (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 Description (No ValueSet): (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 Description (No ValueSet): (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

Terminology Bindings

Path	Conformance	ValueSet	URI
Group.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Group.type	required	GroupType http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.code	example
Group.characteristic.code	example
Group.characteristic.value[x]	example

Constraints

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)

This structure is derived from Group

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

• Openmrs Practitioner (http://fhir.openmrs.org/core/StructureDefinition/omrs-practitioner)

Extensions

This structure refers to these extensions:

• http://fhir.openmrs.org/core/StructureDefinition/omrs-group-description-ext

Other representations of profile: CSV, Excel, Schematron