HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)

This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

GroupProfile

 

The official URL for this profile is: 

http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Group

A set of entities (personnel, material, or places) to be considered together. May be a pool of like-type resources, a team, or combination of personnel, material and places.

This profile builds on Group.

This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by HL7.

View the corresponding GroupModel logical model.

Summary

Prohibited: 1 element

Structures

This structure refers to these other structures:

ODH Mapping Source

This structure represents the following ODH mapping definition:

cimi.entity.Group maps to Group:
  ActiveFlag maps to active
  Type maps to type
  Actual maps to actual
  constrain code to 0..0
  Title maps to name
  GroupCharacteristic maps to characteristic.value[x]
  GroupCharacteristic.GroupCharacteristicCode maps to characteristic.code
  GroupCharacteristic.ExcludeFlag maps to characteristic.exclude
  GroupCharacteristic.TimePeriod maps to characteristic.period
  Member.Patient maps to member.entity
  Member.Practitioner maps to member.entity
  Member.Device maps to member.entity
  Member.Medication maps to member.entity
  Member.Substance maps to member.entity
  Member.ParticipationPeriod maps to member.period
  Member.ActiveFlag maps to member.inactive // TODO this is an inverse TF mapping
  Count maps to quantity
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*ODH Group Profile
grp-1: Can only have members if group is "actual"
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique id
... active Σ0..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required)
... actual ΣI1..1booleanDescriptive or actual
... name Σ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... characteristic I0..*BackboneElementTrait of group members
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example)
.... value[x] 1..1boolean, Quantity, RangeValue held by characteristic
Binding: (unbound) (example)
.... exclude ?!1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member I0..*BackboneElementWho or what is in group
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... entity 1..1Reference(US Core Patient Profile | ODH Practitioner Profile | ODH Device Profile | ODH Medication Profile | ODH Substance Profile)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

Summary

Prohibited: 1 element

Structures

This structure refers to these other structures:

ODH Mapping Source

This structure represents the following ODH mapping definition:

cimi.entity.Group maps to Group:
  ActiveFlag maps to active
  Type maps to type
  Actual maps to actual
  constrain code to 0..0
  Title maps to name
  GroupCharacteristic maps to characteristic.value[x]
  GroupCharacteristic.GroupCharacteristicCode maps to characteristic.code
  GroupCharacteristic.ExcludeFlag maps to characteristic.exclude
  GroupCharacteristic.TimePeriod maps to characteristic.period
  Member.Patient maps to member.entity
  Member.Practitioner maps to member.entity
  Member.Device maps to member.entity
  Member.Medication maps to member.entity
  Member.Substance maps to member.entity
  Member.ParticipationPeriod maps to member.period
  Member.ActiveFlag maps to member.inactive // TODO this is an inverse TF mapping
  Count maps to quantity

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*ODH Group Profile
grp-1: Can only have members if group is "actual"
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique id
... active Σ0..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required)
... actual ΣI1..1booleanDescriptive or actual
... name Σ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... characteristic I0..*BackboneElementTrait of group members
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example)
.... value[x] 1..1boolean, Quantity, RangeValue held by characteristic
Binding: (unbound) (example)
.... exclude ?!1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member I0..*BackboneElementWho or what is in group
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... entity 1..1Reference(US Core Patient Profile | ODH Practitioner Profile | ODH Device Profile | ODH Medication Profile | ODH Substance Profile)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

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Group.languageCommon LanguagesextensibleCommon Languages
Group.typeGroupTyperequiredGroupType
Group.characteristic.code?extexample
Group.characteristic.value[x]?extexample

 

Constraints

IdPathDetailsRequirements
dom-2GroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1GroupIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4GroupIf 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-3GroupIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
grp-1GroupCan only have members if group is "actual"
: member.empty() or (actual = true)
ele-1Group.characteristicAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Group.memberAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())