Page Status: draft 2024-11-19

Group

Page index

Introduction

Regarding information about how the "must support"-property is used in the Swedish National Catalog of Organization, Offerings and Contracts, please refer to the page Resources.

Overview

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
activeΣ0..1boolean
typeΣ1..1codeBinding
actualΣ I1..1boolean
codeΣ0..1CodeableConcept
nameΣ0..1string
quantityΣ0..1unsignedInt
managingEntityΣ I0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeS1..1CodeableConceptBinding
valueBooleanboolean
valueQuantityQuantity
valueReferenceReference()
id0..1string
extensionI0..*Extension
lowS Σ I0..1SimpleQuantity
highS Σ I0..1SimpleQuantity
valueCodeableConceptS0..1CodeableConceptBinding
exclude1..1boolean
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
entityI1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)
periodI0..1Period
inactive0..1boolean
Group
DefinitionRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.
Cardinality0...*
Comments

If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.

Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: 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-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
    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-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • grp-1: Can only have members if group is "actual"
    member.empty() or (actual = true)
Mappings
  • rim: Entity. Role, or Act
  • rim: Entity[determinerCode="GRP" or determinerCode="GRP_KIND"]
Group.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Group.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Group.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Group.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Group.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Group.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
Group.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Group.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Group.identifier
DefinitionA unique business identifier for this group.
Cardinality0...*
TypeIdentifier
SummaryTrue
Requirements

Allows the group to be referenced from external specifications.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • rim: unique(./id[displayable="true" and scope="OBJ"])
Group.active
DefinitionIndicates whether the record for the group is available for use or is merely being retained for historical purposes.
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: ./statusCode
Group.type
DefinitionIdentifies the broad classification of the kind of resources the group includes.
Cardinality1...1
Typecode
Binding

Types of resources that are part of group.

GroupType (required)
SummaryTrue
Requirements

Identifies what type of resources the group is made up of.

Comments

Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: person: ./classCode="PSN" animal: ./classCode="ANM" device: ./classCode="DEV" medication: ./classCode="MMAT" and ./playedRole[isNormalRole() and classCode="THER"] food: ./classCode="FOOD"
Group.actual
DefinitionIf true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
Cardinality1...1
Typeboolean
SummaryTrue
Requirements

There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: true: ./determinerCode="GRP" false: ./determinerCode="GRP_KIND"
Group.code
DefinitionProvides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
Cardinality0...1
TypeCodeableConcept
Binding

Kind of particular resource; e.g. cow, syringe, lake, etc.

(unbound) (example)
SummaryTrue
Comments

This would generally be omitted for Person resources.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.what[x]
  • rim: ./code
Group.name
DefinitionA label assigned to the group for human identification and communication.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Used to identify the group in human communication.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./name[type="ST"]
Group.quantity
DefinitionA count of the number of resource instances that are part of the group.
Cardinality0...1
TypeunsignedInt
SummaryTrue
Requirements

Group size is a common defining characteristic.

Comments

Note that the quantity may be less than the number of members if some of the members are not active.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./quantity
Group.managingEntity
DefinitionEntity responsible for defining and maintaining Group characteristics and/or registered members.
Cardinality0...1
TypeReference(Organization | RelatedPerson | Practitioner | PractitionerRole)
SummaryTrue
Comments

This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Group.characteristic
DefinitionIdentifies traits whose presence r absence is shared by members of the group.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
Requirements

Needs to be a generic mechanism for identifying what individuals can be part of a group.

Comments

All the identified characteristics must be true for an entity to a member of the group.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode="SBJ"]/act[isNormalAct and classCode="OBS" and moodCode="EVN"]
Group.characteristic.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Group.characteristic.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Group.characteristic.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Group.characteristic.code
DefinitionA code that identifies the kind of trait being asserted.
Cardinality1...1
TypeCodeableConcept
Binding

List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

hvo-eligibility-characteristic (required)
Must SupportTrue
Requirements

Need a formal way of identifying the characteristic being described.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
Group.characteristic.value[x]
DefinitionThe value of the trait that holds (or does not hold - see 'exclude') for members of the group.
Cardinality1...1
TypeCodeableConcept
Binding

Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

(unbound) (example)
Must SupportTrue
Requirements

The value of the characteristic is what determines group membership.

Comments

For Range, it means members of the group have a value that falls somewhere within the specified range.

SlicingUnordered, Open, by $this(Type)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./value
Group.characteristic.value[x]:valueRange
DefinitionThe value of the trait that holds (or does not hold - see 'exclude') for members of the group.
Cardinality0...1
TypeRange
Must SupportTrue
Requirements

The value of the characteristic is what determines group membership.

Comments

For Range, it means members of the group have a value that falls somewhere within the specified range.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./value
Group.characteristic.value[x]:valueRange.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Group.characteristic.value[x]:valueRange.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Group.characteristic.value[x]:valueRange.low
DefinitionThe low limit. The boundary is inclusive.
Cardinality0...1
TypeSimpleQuantity
Must SupportTrue
SummaryTrue
Comments

If the low element is missing, the low boundary is not known.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • sqty-1: The comparator is not used on a SimpleQuantity
    comparator.empty()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
  • v2: NR.1
  • rim: ./low
Group.characteristic.value[x]:valueRange.high
DefinitionThe high limit. The boundary is inclusive.
Cardinality0...1
TypeSimpleQuantity
Must SupportTrue
SummaryTrue
Comments

If the high element is missing, the high boundary is not known.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • sqty-1: The comparator is not used on a SimpleQuantity
    comparator.empty()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
  • v2: NR.2
  • rim: ./high
Group.characteristic.value[x]:valueCodeableConcept
DefinitionThe value of the trait that holds (or does not hold - see 'exclude') for members of the group.
Cardinality0...1
TypeCodeableConcept
Binding

Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

hvo-eligibility-characteristic-value (required)
Must SupportTrue
Requirements

The value of the characteristic is what determines group membership.

Comments

For Range, it means members of the group have a value that falls somewhere within the specified range.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./value
Group.characteristic.exclude
DefinitionIf true, indicates the characteristic is one that is NOT held by members of the group.
Cardinality1...1
Typeboolean
Requirements

Sometimes group membership is determined by characteristics not possessed.

Comments

This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./valueNegationInd
Group.characteristic.period
DefinitionThe period over which the characteristic is tested; e.g. the patient had an operation during the month of June.
Cardinality0...1
TypePeriod
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
Group.member
DefinitionIdentifies the resource instances that are members of the group.
Cardinality0...*
TypeBackboneElement
Requirements

Often the only thing of interest about a group is "who's in it".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./scopedRole[isNormalRole() and classCode="MBR"]/player
Group.member.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Group.member.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Group.member.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Group.member.entity
DefinitionA reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.
Cardinality1...1
TypeReference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Group.member.period
DefinitionThe period that the member was in the group, if known.
Cardinality0...1
TypePeriod
Requirements

Need to track who was in a group at a particular time.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
Group.member.inactive
DefinitionA flag to indicate that the member is no longer in the group, but previously may have been a member.
Cardinality0...1
Typeboolean
Requirements

Sometimes you don't know when someone stopped being in a group, but not when.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="HVOEligibilityGroup" />
    <url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOEligibilityGroup" />
    <name value="HVOEligibilityGroup" />
    <title value="HVOEligibilityGroup" />
    <status value="draft" />
    <description value="HVOEligibilityGroup profile for HVO" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Group" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Group" />
    <derivation value="constraint" />
    <differential>
        <element id="Group.characteristic">
            <path value="Group.characteristic" />
            <mustSupport value="true" />
        </element>
        <element id="Group.characteristic.code">
            <path value="Group.characteristic.code" />
            <short value="A code representing a characteristic a person should have to be eligible for the service. Examples include age, gender, etc. Use valueRange for numerical values, eg age, and valueCodeableConcept for coded values, eg gender." />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://electronichealth.se/fhir/hvo/ValueSet/hvo-eligibility-characteristic" />
            </binding>
        </element>
        <element id="Group.characteristic.value[x]">
            <path value="Group.characteristic.value[x]" />
            <slicing>
                <discriminator>
                    <type value="type" />
                    <path value="$this" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
            <mustSupport value="true" />
        </element>
        <element id="Group.characteristic.value[x]:valueRange">
            <path value="Group.characteristic.value[x]" />
            <sliceName value="valueRange" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Range" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Group.characteristic.value[x]:valueRange.low">
            <path value="Group.characteristic.value[x].low" />
            <short value="The minimum value of the characteristic which makes a person eligible for a service. For example, if the characteristic is age, the minimum value might be 18 if only adults are eligible for the service." />
            <mustSupport value="true" />
        </element>
        <element id="Group.characteristic.value[x]:valueRange.high">
            <path value="Group.characteristic.value[x].high" />
            <short value="The maximum value of the characteristic which makes a person eligible for a service. For example, if the characteristic is age, the maximum value might be 18 if only children are eligible fo the service." />
            <mustSupport value="true" />
        </element>
        <element id="Group.characteristic.value[x]:valueCodeableConcept">
            <path value="Group.characteristic.value[x]" />
            <sliceName value="valueCodeableConcept" />
            <short value="The coded value of the characteristic which makes a person eligible for a service. For example, if the characteristic is to have a certain diagnosis, the value might be &#39;diabetes type 2&#39;." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://electronichealth.se/fhir/hvo/ValueSet/hvo-eligibility-characteristic-value" />
            </binding>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "HVOEligibilityGroup",
    "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOEligibilityGroup",
    "name": "HVOEligibilityGroup",
    "title": "HVOEligibilityGroup",
    "status": "draft",
    "description": "HVOEligibilityGroup profile for HVO",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Group",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Group",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Group.characteristic",
                "path": "Group.characteristic",
                "mustSupport": true
            },
            {
                "id": "Group.characteristic.code",
                "path": "Group.characteristic.code",
                "short": "A code representing a characteristic a person should have to be eligible for the service. Examples include age, gender, etc. Use valueRange for numerical values, eg age, and valueCodeableConcept for coded values, eg gender.",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://electronichealth.se/fhir/hvo/ValueSet/hvo-eligibility-characteristic"
                }
            },
            {
                "id": "Group.characteristic.value[x]",
                "path": "Group.characteristic.value[x]",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "type",
                            "path": "$this"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "Group.characteristic.value[x]:valueRange",
                "path": "Group.characteristic.value[x]",
                "sliceName": "valueRange",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Range"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Group.characteristic.value[x]:valueRange.low",
                "path": "Group.characteristic.value[x].low",
                "short": "The minimum value of the characteristic which makes a person eligible for a service. For example, if the characteristic is age, the minimum value might be 18 if only adults are eligible for the service.",
                "mustSupport": true
            },
            {
                "id": "Group.characteristic.value[x]:valueRange.high",
                "path": "Group.characteristic.value[x].high",
                "short": "The maximum value of the characteristic which makes a person eligible for a service. For example, if the characteristic is age, the maximum value might be 18 if only children are eligible fo the service.",
                "mustSupport": true
            },
            {
                "id": "Group.characteristic.value[x]:valueCodeableConcept",
                "path": "Group.characteristic.value[x]",
                "sliceName": "valueCodeableConcept",
                "short": "The coded value of the characteristic which makes a person eligible for a service. For example, if the characteristic is to have a certain diagnosis, the value might be 'diabetes type 2'.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://electronichealth.se/fhir/hvo/ValueSet/hvo-eligibility-characteristic-value"
                }
            }
        ]
    }
}

Details

Supported operations

HTTP methods

Operation Supported Comment
Search (GET, POST) yes/no Kommentar
Insert (POST) yes/no Kommentar
Update (PUT) yes/no Kommentar
Delete (DEL) yes/no Kommentar
Operation (GET, POST) yes/no Kommentar

Query operations

Supported Queries

  1. .../Group/[id]
  2. ../Group?identifier=[value]

Other operations

Operation name HTTP verbs Comment
$namn Verb Kommentar