Page Status: draft updated 2025-05-07
Group
Information domain hvo-offerings, where this resource is represented as part Målgrupp and Villkor
Page index
Introduction
The Group resource in the context of the Swedish National Catalog of Organization, Offerings and Contracts holds information about constraints which identify a group of citizens that makes up a target group for a HVOService. It is also used to express conditions that have to be met in order to receive a service.
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 Profiles.
Overview
HVOEligibilityGroup (Group) | I | Group | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | Σ | 0..1 | boolean |
type | Σ | 1..1 | codeBindingPattern |
actual | Σ I | 1..1 | booleanPattern |
code | Σ | 0..1 | CodeableConcept |
name | Σ | 0..1 | string |
quantity | Σ | 0..1 | unsignedInt |
managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) |
characteristic | S | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | S | 1..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
value[x] | S | 1..1 | |
(All Slices) | |||
valueBoolean | boolean | ||
valueQuantity | Quantity | ||
valueReference | Reference() | ||
valueRange | S | 0..1 | Range |
id | 0..1 | string | |
extension | I | 0..* | Extension |
low | S Σ | 0..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | Σ I | 0..1 | uri |
code | Σ | 0..1 | code |
high | S Σ | 0..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | Σ I | 0..1 | uri |
code | Σ | 0..1 | code |
valueCodeableConcept | S | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
exclude | 1..1 | booleanFixed Value | |
period | 0..1 | Period | |
member | I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
entity | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | |
period | 0..1 | Period | |
inactive | 0..1 | boolean |
Group | |
Definition | Represents 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. |
Cardinality | 0...* |
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 |
|
Mappings |
|
Group.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 | |
Definition | The 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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Group.implicitRules | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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 |
|
Group.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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 |
|
Group.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, 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 |
|
Mappings |
|
Group.contained | |
Definition | These 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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline 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 |
|
Group.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Invariants |
|
Mappings |
|
Group.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, 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. |
Invariants |
|
Mappings |
|
Group.identifier | |
Definition | A unique business identifier for this group. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Allows the group to be referenced from external specifications. |
Invariants |
|
Mappings |
|
Group.active | |
Definition | Indicates whether the record for the group is available for use or is merely being retained for historical purposes. |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
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 |
|
Mappings |
|
Group.type | |
Definition | Identifies the broad classification of the kind of resources the group includes. |
Cardinality | 1...1 |
Type | code |
Binding | Types of resources that are part of group. |
Summary | True |
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 |
|
Pattern | person |
Mappings |
|
Group.actual | |
Definition | If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals. |
Cardinality | 1...1 |
Type | boolean |
Summary | True |
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 |
|
Pattern | false |
Mappings |
|
Group.code | |
Definition | Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Kind of particular resource; e.g. cow, syringe, lake, etc. |
Summary | True |
Comments | This would generally be omitted for Person resources. |
Invariants |
|
Mappings |
|
Group.name | |
Definition | A label assigned to the group for human identification and communication. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Used to identify the group in human communication. |
Invariants |
|
Mappings |
|
Group.quantity | |
Definition | A count of the number of resource instances that are part of the group. |
Cardinality | 0...1 |
Type | unsignedInt |
Summary | True |
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 |
|
Mappings |
|
Group.managingEntity | |
Definition | Entity responsible for defining and maintaining Group characteristics and/or registered members. |
Cardinality | 0...1 |
Type | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) |
Summary | True |
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 |
|
Group.characteristic | |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Cardinality | 1...1 |
Type | BackboneElement |
Must Support | True |
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 |
|
Mappings |
|
Group.characteristic.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Group.characteristic.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Invariants |
|
Mappings |
|
Group.characteristic.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Group.characteristic.code | |
Definition | A code that identifies the kind of trait being asserted. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Must Support | True |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants |
|
Mappings |
|
Group.characteristic.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Group.characteristic.code.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Group.characteristic.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Group.characteristic.code.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Group.characteristic.code.coding.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Group.characteristic.code.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Group.characteristic.code.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Group.characteristic.code.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Group.characteristic.code.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Group.characteristic.code.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Group.characteristic.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Must Support | True |
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. |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Cardinality | 0...1 |
Type | Range |
Must Support | True |
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 |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Group.characteristic.value[x]:valueRange.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.low | |
Definition | The low limit. The boundary is inclusive. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the low boundary is not known. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.low.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Group.characteristic.value[x]:valueRange.low.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.low.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.low.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.low.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.low.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.low.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.high | |
Definition | The high limit. The boundary is inclusive. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the high element is missing, the high boundary is not known. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.high.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Group.characteristic.value[x]:valueRange.high.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.high.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.high.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.high.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.high.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueRange.high.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Must Support | True |
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 |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.coding.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Group.characteristic.value[x]:valueCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Group.characteristic.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Cardinality | 1...1 |
Type | boolean |
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 |
|
Fixed Value | false |
Mappings |
|
Group.characteristic.period | |
Definition | The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. |
Cardinality | 0...1 |
Type | Period |
Invariants |
|
Group.member | |
Definition | Identifies the resource instances that are members of the group. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | Often the only thing of interest about a group is "who's in it". |
Invariants |
|
Mappings |
|
Group.member.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Group.member.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Invariants |
|
Mappings |
|
Group.member.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Group.member.entity | |
Definition | A 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. |
Cardinality | 1...1 |
Type | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) |
Invariants |
|
Group.member.period | |
Definition | The period that the member was in the group, if known. |
Cardinality | 0...1 |
Type | Period |
Requirements | Need to track who was in a group at a particular time. |
Invariants |
|
Group.member.inactive | |
Definition | A flag to indicate that the member is no longer in the group, but previously may have been a member. |
Cardinality | 0...1 |
Type | boolean |
Requirements | Sometimes you don't know when someone stopped being in a group, but not when. |
Invariants |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="HVOEligibilityGroup" /> <url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOEligibilityGroup" /> <version value="0.1.0" /> <name value="HVOEligibilityGroup" /> <title value="HVOEligibilityGroup" /> <status value="draft" /> <description value="HVOEligibilityGroup profile for HVO" /> <fhirVersion value="4.0.1" /> <mapping> <identity value="HVOEligibilityGroupToHVOMalgruppLogical" /> <uri value="HVOMalgruppLogical" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Group" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Group" /> <derivation value="constraint" /> <differential> <element id="Group.type"> <path value="Group.type" /> <patternCode value="person" /> </element> <element id="Group.actual"> <path value="Group.actual" /> <patternBoolean value="false" /> </element> <element id="Group.characteristic"> <path value="Group.characteristic" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Group.characteristic.code"> <path value="Group.characteristic.code" /> <short value="A code representing the type of 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> <mapping> <identity value="HVOEligibilityGroupToHVOMalgruppLogical" /> <map value="kod" /> </mapping> </element> <element id="Group.characteristic.code.coding"> <path value="Group.characteristic.code.coding" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Group.characteristic.code.coding.system"> <path value="Group.characteristic.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Group.characteristic.code.coding.code"> <path value="Group.characteristic.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </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" /> <mapping> <identity value="HVOEligibilityGroupToHVOMalgruppLogical" /> <map value="vardemin" /> </mapping> </element> <element id="Group.characteristic.value[x]:valueRange.low.value"> <path value="Group.characteristic.value[x].low.value" /> <min value="1" /> <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" /> <mapping> <identity value="HVOEligibilityGroupToHVOMalgruppLogical" /> <map value="vardemax" /> </mapping> </element> <element id="Group.characteristic.value[x]:valueRange.high.value"> <path value="Group.characteristic.value[x].high.value" /> <min value="1" /> <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 'diabetes type 2'." /> <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> <mapping> <identity value="HVOEligibilityGroupToHVOMalgruppLogical" /> <map value="vardekod" /> </mapping> </element> <element id="Group.characteristic.value[x]:valueCodeableConcept.coding"> <path value="Group.characteristic.value[x].coding" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Group.characteristic.value[x]:valueCodeableConcept.coding.system"> <path value="Group.characteristic.value[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Group.characteristic.value[x]:valueCodeableConcept.coding.code"> <path value="Group.characteristic.value[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Group.characteristic.exclude"> <path value="Group.characteristic.exclude" /> <fixedBoolean value="false" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "HVOEligibilityGroup", "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOEligibilityGroup", "version": "0.1.0", "name": "HVOEligibilityGroup", "title": "HVOEligibilityGroup", "status": "draft", "description": "HVOEligibilityGroup profile for HVO", "fhirVersion": "4.0.1", "mapping": [ { "identity": "HVOEligibilityGroupToHVOMalgruppLogical", "uri": "HVOMalgruppLogical" } ], "kind": "resource", "abstract": false, "type": "Group", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Group", "derivation": "constraint", "differential": { "element": [ { "id": "Group.type", "path": "Group.type", "patternCode": "person" }, { "id": "Group.actual", "path": "Group.actual", "patternBoolean": false }, { "id": "Group.characteristic", "path": "Group.characteristic", "min": 1, "max": "1", "mustSupport": true }, { "id": "Group.characteristic.code", "path": "Group.characteristic.code", "short": "A code representing the type of 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" }, "mapping": [ { "identity": "HVOEligibilityGroupToHVOMalgruppLogical", "map": "kod" } ] }, { "id": "Group.characteristic.code.coding", "path": "Group.characteristic.code.coding", "min": 1, "max": "1", "mustSupport": true }, { "id": "Group.characteristic.code.coding.system", "path": "Group.characteristic.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Group.characteristic.code.coding.code", "path": "Group.characteristic.code.coding.code", "min": 1, "mustSupport": true }, { "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, "mapping": [ { "identity": "HVOEligibilityGroupToHVOMalgruppLogical", "map": "vardemin" } ] }, { "id": "Group.characteristic.value[x]:valueRange.low.value", "path": "Group.characteristic.value[x].low.value", "min": 1, "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, "mapping": [ { "identity": "HVOEligibilityGroupToHVOMalgruppLogical", "map": "vardemax" } ] }, { "id": "Group.characteristic.value[x]:valueRange.high.value", "path": "Group.characteristic.value[x].high.value", "min": 1, "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" }, "mapping": [ { "identity": "HVOEligibilityGroupToHVOMalgruppLogical", "map": "vardekod" } ] }, { "id": "Group.characteristic.value[x]:valueCodeableConcept.coding", "path": "Group.characteristic.value[x].coding", "min": 1, "max": "1", "mustSupport": true }, { "id": "Group.characteristic.value[x]:valueCodeableConcept.coding.system", "path": "Group.characteristic.value[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Group.characteristic.value[x]:valueCodeableConcept.coding.code", "path": "Group.characteristic.value[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Group.characteristic.exclude", "path": "Group.characteristic.exclude", "fixedBoolean": false } ] } }
Details
Validation rules
Rule ID | Element | Description | Expression | Error | Severity |
---|---|---|---|---|---|
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
.../Group/[id]
../Group?identifier=[value]
Other operations
Operation name | HTTP verbs | Comment |
---|---|---|
$namn | Verb | Kommentar |