OpenMRS FHIR2 Implementation Guide
0.1.0 - ci-build

OpenMRS FHIR2 Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: OMRS Group

Official URL: http://fhir.openmrs.org/fhir/StructureDefinition/omrs-group Version: 0.1.0
Active as of 2022-10-08 Computable Name: OMRSGroup

A Group Resource is described as Cohort in Fhir2 OMRS

Usage:

Formal Views of Profile Content

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

This structure is derived from Group

Summary

Mandatory: 4 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of multiple entities
... id 0..1idLogical id of this artifact
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... description 1..1(Complex)Group descriptive extension
URL: http://fhir.openmrs.org/fhir/StructureDefinition/omrs-group-description-ext
... active 1..1booleanWhether this group's record is in active use
... type 1..1codeperson | animal | practitioner | device | medication | substance
... name 1..1stringLabel for Group
... managingEntity 0..1Reference(Openmrs Practitioner)Entity that is the custodian of the Group's definition
... characteristic 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... description 1..1(Complex)Group descriptive extension
URL: http://fhir.openmrs.org/fhir/StructureDefinition/omrs-group-description-ext
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active Σ1..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

... actual ΣC1..1booleanDescriptive or actual
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ1..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Openmrs Practitioner)Entity that is the custodian of the Group's definition
... member C0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity 1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member
.... period 0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format

This structure is derived from Group

Summary

Mandatory: 4 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of multiple entities
... id 0..1idLogical id of this artifact
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... description 1..1(Complex)Group descriptive extension
URL: http://fhir.openmrs.org/fhir/StructureDefinition/omrs-group-description-ext
... active 1..1booleanWhether this group's record is in active use
... type 1..1codeperson | animal | practitioner | device | medication | substance
... name 1..1stringLabel for Group
... managingEntity 0..1Reference(Openmrs Practitioner)Entity that is the custodian of the Group's definition
... characteristic 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... description 1..1(Complex)Group descriptive extension
URL: http://fhir.openmrs.org/fhir/StructureDefinition/omrs-group-description-ext
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active Σ1..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

... actual ΣC1..1booleanDescriptive or actual
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ1..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Openmrs Practitioner)Entity that is the custodian of the Group's definition
... member C0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity 1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member
.... period 0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Group.typerequiredGroupType
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()