Canonical Resource Management Infrastructure Implementation Guide
2.0.0 - STU 2 International flag

Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Shareable Group - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the crmi-shareablegroup resource profile

Guidance on how to interpret the contents of this table can be foundhere

0. 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.

ShortGroup of multiple entities
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.

Control10..1*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
grp-1: Can only have members if group is "actual" (member.empty() or (actual = true))
gdf-1: Group definition must have either a characteristicExpression or characteristics, but not both (extension('http://hl7.org/fhir/StructureDefinition/characteristicExpression').exists() xor characteristic.exists())
shr-1: If knowledge capabilities are stated, they SHALL include shareable (extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists())
grp-1: Can only have members if group is "actual" (member.empty() or (actual = true))
2. 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.

ShortA set of rules under which this content was created
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.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Group.extension
Definition

An Extension


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.

ShortExtensionAdditional content defined by implementations
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.

Control30..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Group.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Group.extension:library
    Slice Namelibrary
    Definition

    A reference to a Library containing the formal logic used by the artifact.

    ShortA library containing logic used by the artifact
    Comments

    For questionnaires, see additional guidance and examples in the SDC implementation guide.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(CQF Library) (Extension Type: canonical(Library))
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Group.extension:characteristicExpression
    Slice NamecharacteristicExpression
    Definition

    An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of definitional. When this expression is used, the Group resource cannot have any characteristic elements; this mechanism is exclusive with characteristics. The result of the expression SHALL be boolean-valued. The expression SHALL be parameterized with a %context variable that represents the subject being tested for membership. If evaluation of the expression results in true, the subject is considered a member of the group.

    ShortCriteria for group membership
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Characteristic Expression) (Extension Type: Expression)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Group.extension:knowledgeCapability
    Slice NameknowledgeCapability
    Definition

    Defines a knowledge capability afforded by this knowledge artifact.

    Shortshareable | computable | publishable | executable
    Control0..*
    This element is affected by the following invariants: shr-1
    TypeExtension(CQF Knowledge capability) (Extension Type: code)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    12. Group.extension:artifactComment
    Slice NameartifactComment
    Definition

    A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

    ShortAdditional documentation, review, or usage guidance
    Control0..*
    TypeExtension(Artifact Comment) (Complex Extension)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-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())
    14. Group.extension:url
    Slice Nameurl
    Definition

    An absolute URI that is used to identify this artifact when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this artifact is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the artifact is stored on different servers.

    ShortCanonical identifier for this artifact, represented as a URI (globally unique)
    Comments

    Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

    The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

    In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

    Control1..1
    TypeExtension(Artifact URL) (Extension Type: uri)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    16. Group.extension:version
    Slice Nameversion
    Definition

    The identifier that is used to identify this version of the artifact when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the artifact author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

    ShortBusiness version of the artifact
    Control1..1
    TypeExtension(ArtifactVersion) (Extension Type: string)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    18. Group.extension:versionAlgorithm
    Slice NameversionAlgorithm
    Definition

    Indicates the mechanism used to compare versions to determine which is more current.

    ShortHow to compare versions
    Comments

    If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

    Control0..1
    TypeExtension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    20. Group.extension:versionPolicy
    Slice NameversionPolicy
    Definition

    Defines the versioning policy of the artifact.

    Shortmetadata | strict
    Control0..1
    TypeExtension(Artifact Version Policy) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    22. Group.extension:webSource
    Slice NamewebSource
    Definition

    Where a human readable web page describing the resource can be found, if it's at a different location to the canonical URL itself.

    Shortweb-source
    Control0..1
    TypeExtension(Web Source) (Extension Type: url)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    24. Group.extension:title
    Slice Nametitle
    Definition

    A short, descriptive, user-friendly title for the artifact.

    ShortName for this artifact (human friendly)
    Comments

    This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

    Control1..1
    TypeExtension(Artifact Title) (Extension Type: string)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    26. Group.extension:experimental
    Slice Nameexperimental
    Definition

    A Boolean value to indicate that this artifact is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

    ShortFor testing purposes, not real usage
    Control0..1
    TypeExtension(Artifact Experimental) (Extension Type: boolean)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    28. Group.extension:publisher
    Slice Namepublisher
    Definition

    The name of the organization or individual responsible for the release and ongoing maintenance of the artifact.

    ShortName of the publisher/steward (organization or individual)
    Comments

    Usually an organization but may be an individual. The publisher (or steward) of the artifact is the organization or individual primarily responsible for the maintenance and upkeep of the artifact. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the artifact. This item SHOULD be populated unless the information is available from context.

    Control0..1
    TypeExtension(Artifact Publisher) (Extension Type: string)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    30. Group.extension:description
    Slice Namedescription
    Definition

    A free text natural language description of the artifact from a consumer's perspective.

    ShortNatural language description of the artifact
    Comments

    This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the artifact as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the artifact is presumed to be the predominant language in the place the artifact was created).

    Control0..1
    TypeExtension(Artifact Description) (Extension Type: markdown)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    32. Group.modifierExtension
    Definition

    An Extension


    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).

    ShortExtensionExtensions that cannot be ignored
    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.

    Control10..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    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.

    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis element introduces a set of slices on Group.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 34. Group.modifierExtension:status
      Slice Namestatus
      Definition

      The status of this artifact. Enables tracking the life-cycle of the content.

      Shortdraft | active | retired | unknown
      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Artifact Status) (Extension Type: code)
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration
      Must Supporttrue
      Summaryfalse
      Invariantsele-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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      36. Group.identifier
      Definition

      A unique business identifier for this group.

      ShortUnique id
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Allows the group to be referenced from external specifications.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. Group.active
      Definition

      Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

      ShortWhether this group's record is in active use
      Control0..1
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      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).

      Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. Group.type
      Definition

      Identifies the broad classification of the kind of resources the group includes.

      Shortperson | animal | practitioner | device | medication | substance
      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.).

      Control1..1
      BindingThe codes SHALL be taken from GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1
      (required to http://hl7.org/fhir/ValueSet/group-type|4.0.1)

      Types of resources that are part of group.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

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

      Fixed Valueperson
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. 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.

      ShortDescriptive or actual
      Control1..1
      This element is affected by the following invariants: grp-1
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      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.

      Fixed Valuefalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. Group.code
      Definition

      Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.

      ShortKind of Group members
      Comments

      This would generally be omitted for Person resources.

      Control0..1
      Binding

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

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. Group.name
      Definition

      A label assigned to the group for human identification and communication.

      ShortLabel for Group
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Used to identify the group in human communication.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. Group.managingEntity
      Definition

      Entity responsible for defining and maintaining Group characteristics and/or registered members.

      ShortEntity that is the custodian of the Group's definition
      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.

      Control0..1
      TypeReference(Organization, RelatedPerson, Practitioner, PractitionerRole)
      Is Modifierfalse
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. Group.managingEntity.extension:profile
      Slice Nameprofile
      Definition

      A reference to a resource, canonical resource, or non-FHIR resource.

      ShortThe artifact
      Control0..1
      TypeExtension(Artifact Reference) (Extension Type: Choice of: Reference(Resource), canonical, uri)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-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())
      52. Group.managingEntity.extension:profile.extension
      Definition

      An Extension


      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.

      ShortExtensionAdditional content defined by implementations
      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.

      Control0..0*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-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())
      SlicingThis element introduces a set of slices on Group.managingEntity.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 54. Group.managingEntity.extension:profile.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/artifact-reference
        56. Group.managingEntity.extension:profile.value[x]
        Definition

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortValue of extension
        Control10..1
        Typecanonical, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Group.characteristic
        Definition

        Identifies traits whose presence r absence is shared by members of the group.

        ShortInclude / Exclude group members by Trait
        Comments

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

        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. 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).

        ShortExtensions that cannot be ignored even if unrecognized
        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        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.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-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())
        62. Group.characteristic.code
        Definition

        A code that identifies the kind of trait being asserted.

        ShortKind of characteristic
        Control1..1
        Binding

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

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        Need a formal way of identifying the characteristic being described.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        64. Group.characteristic.value[x]
        Definition

        The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

        ShortValue held by characteristic
        Comments

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

        Control1..1
        Binding

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

        TypeChoice of: CodeableConcept, boolean, Quantity, Range, Reference
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Summaryfalse
        Requirements

        The value of the characteristic is what determines group membership.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Group.characteristic.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • type @ $this
        • 66. Group.characteristic.value[x]:valueReference
          Slice NamevalueReference
          Definition

          The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

          ShortValue held by characteristic
          Comments

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

          Control01..1
          TypeReference, boolean, Quantity, Range, CodeableConcept
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          The value of the characteristic is what determines group membership.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          68. Group.characteristic.value[x]:valueReference.extension:valueCanonical
          Slice NamevalueCanonical
          Definition

          Instances that conform to the referenced profile are included (or excluded if characteristic.exclude is true) in the cohort.

          ShortInstances that conform to the referenced profile
          Control0..1
          TypeExtension(CRMI Group Characteristic Value Canonical Extension) (Extension Type: canonical)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-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())
          70. Group.characteristic.exclude
          Definition

          If true, indicates the characteristic is one that is NOT held by members of the group.

          ShortGroup includes or excludes
          Comments

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

          Control1..1
          Typeboolean
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Requirements

          Sometimes group membership is determined by characteristics not possessed.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          72. Group.member
          Definition

          Identifies the resource instances that are members of the group.

          ShortWho or what is in group
          Control0..*
          This element is affected by the following invariants: grp-1
          TypeBackboneElement
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          74. 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).

          ShortExtensions that cannot be ignored even if unrecognized
          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.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          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.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-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())
          76. 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.

          ShortReference to the group member
          Control1..1
          TypeReference(Patient, Practitioner, PractitionerRole, Device, Medication, Substance, Group)
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          78. Group.member.entity.extension:profile
          Slice Nameprofile
          Definition

          A reference to a resource, canonical resource, or non-FHIR resource.

          ShortThe artifact
          Control0..1
          TypeExtension(Artifact Reference) (Extension Type: Choice of: Reference(Resource), canonical, uri)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-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())
          80. Group.member.entity.extension:profile.extension
          Definition

          An Extension


          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.

          ShortExtensionAdditional content defined by implementations
          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.

          Control0..0*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-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())
          SlicingThis element introduces a set of slices on Group.member.entity.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 82. Group.member.entity.extension:profile.url
            Definition

            Source of the definition for the extension code - a logical name or a URL.

            Shortidentifies the meaning of the extension
            Comments

            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

            Control1..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/artifact-reference
            84. Group.member.entity.extension:profile.value[x]
            Definition

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            ShortValue of extension
            Control10..1
            Typecanonical, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            gdf-2: Reference must be to a structure definition (resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition'))
            86. Group.member.entity.extension:nonCanonicalReference
            Slice NamenonCanonicalReference
            Definition

            Create a reference, following canonical reference semantics, to an artifact that uses the artifact-url and artifact-version extensions to provide a canonical identifier.

            ShortThe artifact
            Control0..1
            TypeExtension(Artifact URI Reference) (Extension Type: uri)
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-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())

            Guidance on how to interpret the contents of this table can be foundhere

            0. Group
            Control1..1
            Invariantsshr-1: If knowledge capabilities are stated, they SHALL include shareable (extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists())
            2. Group.extension:knowledgeCapability
            Slice NameknowledgeCapability
            TypeExtension(CQF Knowledge capability) (Extension Type: code)
            Must Supporttrue
            4. Group.extension:artifactComment
            Slice NameartifactComment
            Control0..*
            TypeExtension(Artifact Comment) (Complex Extension)
            Must Supporttrue
            6. Group.extension:url
            Slice Nameurl
            Control1..1
            TypeExtension(Artifact URL) (Extension Type: uri)
            Must Supporttrue
            8. Group.extension:version
            Slice Nameversion
            Control1..1
            TypeExtension(ArtifactVersion) (Extension Type: string)
            Must Supporttrue
            10. Group.extension:versionAlgorithm
            Slice NameversionAlgorithm
            Control0..1
            TypeExtension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)
            Must Supporttrue
            12. Group.extension:versionPolicy
            Slice NameversionPolicy
            Control0..1
            TypeExtension(Artifact Version Policy) (Extension Type: CodeableConcept)
            Must Supporttrue
            14. Group.extension:webSource
            Slice NamewebSource
            Control0..1
            TypeExtension(Web Source) (Extension Type: url)
            Must Supporttrue
            16. Group.extension:title
            Slice Nametitle
            Control1..1
            TypeExtension(Artifact Title) (Extension Type: string)
            Must Supporttrue
            18. Group.extension:experimental
            Slice Nameexperimental
            Control0..1
            TypeExtension(Artifact Experimental) (Extension Type: boolean)
            Must Supporttrue
            20. Group.extension:publisher
            Slice Namepublisher
            Control0..1
            TypeExtension(Artifact Publisher) (Extension Type: string)
            Must Supporttrue
            22. Group.extension:description
            Slice Namedescription
            Control0..1
            TypeExtension(Artifact Description) (Extension Type: markdown)
            Must Supporttrue
            24. Group.modifierExtension:status
            Slice Namestatus
            Control1..1
            TypeExtension(Artifact Status) (Extension Type: code)
            Must Supporttrue
            26. Group.name
            Must Supporttrue

            Guidance on how to interpret the contents of this table can be foundhere

            0. 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.

            ShortGroup of multiple entities
            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.

            Control1..1
            Is Modifierfalse
            Must Supportfalse
            Summaryfalse
            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
            dom-6: A resource should have narrative for robust management (text.`div`.exists())
            grp-1: Can only have members if group is "actual" (member.empty() or (actual = true))
            gdf-1: Group definition must have either a characteristicExpression or characteristics, but not both (extension('http://hl7.org/fhir/StructureDefinition/characteristicExpression').exists() xor characteristic.exists())
            shr-1: If knowledge capabilities are stated, they SHALL include shareable (extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists())
            2. Group.id
            Definition

            The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

            ShortLogical id of this artifact
            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.

            Control0..1
            Typeid
            Is Modifierfalse
            Summarytrue
            4. 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.

            ShortMetadata about the resource
            Control0..1
            TypeMeta
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            6. 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.

            ShortA set of rules under which this content was created
            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.

            Control0..1
            Typeuri
            Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            8. Group.language
            Definition

            The base language in which the resource is written.

            ShortLanguage of the resource content
            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).

            Control0..1
            BindingThe codes SHOULD be taken from CommonLanguages
            (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

            A human language.

            Additional BindingsPurpose
            AllLanguagesMax Binding
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            10. 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.

            ShortText summary of the resource, for human interpretation
            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.

            Control0..1
            TypeNarrative
            Is Modifierfalse
            Summaryfalse
            Alternate Namesnarrative, html, xhtml, display
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            12. 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.

            ShortContained, inline 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.

            Control0..*
            TypeResource
            Is Modifierfalse
            Summaryfalse
            Alternate Namesinline resources, anonymous resources, contained resources
            14. Group.extension
            Definition

            An Extension

            ShortExtension
            Control3..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Invariantsele-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())
            SlicingThis element introduces a set of slices on Group.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 16. Group.extension:library
              Slice Namelibrary
              Definition

              A reference to a Library containing the formal logic used by the artifact.

              ShortA library containing logic used by the artifact
              Comments

              For questionnaires, see additional guidance and examples in the SDC implementation guide.

              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(CQF Library) (Extension Type: canonical(Library))
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              18. Group.extension:characteristicExpression
              Slice NamecharacteristicExpression
              Definition

              An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of definitional. When this expression is used, the Group resource cannot have any characteristic elements; this mechanism is exclusive with characteristics. The result of the expression SHALL be boolean-valued. The expression SHALL be parameterized with a %context variable that represents the subject being tested for membership. If evaluation of the expression results in true, the subject is considered a member of the group.

              ShortCriteria for group membership
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Characteristic Expression) (Extension Type: Expression)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              20. Group.extension:knowledgeCapability
              Slice NameknowledgeCapability
              Definition

              Defines a knowledge capability afforded by this knowledge artifact.

              Shortshareable | computable | publishable | executable
              Control0..*
              This element is affected by the following invariants: shr-1
              TypeExtension(CQF Knowledge capability) (Extension Type: code)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              22. Group.extension:artifactComment
              Slice NameartifactComment
              Definition

              A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

              ShortAdditional documentation, review, or usage guidance
              Control0..*
              TypeExtension(Artifact Comment) (Complex Extension)
              Is Modifierfalse
              Must Supporttrue
              Invariantsele-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())
              24. Group.extension:url
              Slice Nameurl
              Definition

              An absolute URI that is used to identify this artifact when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this artifact is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the artifact is stored on different servers.

              ShortCanonical identifier for this artifact, represented as a URI (globally unique)
              Comments

              Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

              The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

              In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

              Control1..1
              TypeExtension(Artifact URL) (Extension Type: uri)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              26. Group.extension:version
              Slice Nameversion
              Definition

              The identifier that is used to identify this version of the artifact when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the artifact author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

              ShortBusiness version of the artifact
              Control1..1
              TypeExtension(ArtifactVersion) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              28. Group.extension:versionAlgorithm
              Slice NameversionAlgorithm
              Definition

              Indicates the mechanism used to compare versions to determine which is more current.

              ShortHow to compare versions
              Comments

              If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

              Control0..1
              TypeExtension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              30. Group.extension:versionPolicy
              Slice NameversionPolicy
              Definition

              Defines the versioning policy of the artifact.

              Shortmetadata | strict
              Control0..1
              TypeExtension(Artifact Version Policy) (Extension Type: CodeableConcept)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              32. Group.extension:webSource
              Slice NamewebSource
              Definition

              Where a human readable web page describing the resource can be found, if it's at a different location to the canonical URL itself.

              Shortweb-source
              Control0..1
              TypeExtension(Web Source) (Extension Type: url)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              34. Group.extension:title
              Slice Nametitle
              Definition

              A short, descriptive, user-friendly title for the artifact.

              ShortName for this artifact (human friendly)
              Comments

              This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

              Control1..1
              TypeExtension(Artifact Title) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              36. Group.extension:experimental
              Slice Nameexperimental
              Definition

              A Boolean value to indicate that this artifact is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

              ShortFor testing purposes, not real usage
              Control0..1
              TypeExtension(Artifact Experimental) (Extension Type: boolean)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              38. Group.extension:publisher
              Slice Namepublisher
              Definition

              The name of the organization or individual responsible for the release and ongoing maintenance of the artifact.

              ShortName of the publisher/steward (organization or individual)
              Comments

              Usually an organization but may be an individual. The publisher (or steward) of the artifact is the organization or individual primarily responsible for the maintenance and upkeep of the artifact. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the artifact. This item SHOULD be populated unless the information is available from context.

              Control0..1
              TypeExtension(Artifact Publisher) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              40. Group.extension:description
              Slice Namedescription
              Definition

              A free text natural language description of the artifact from a consumer's perspective.

              ShortNatural language description of the artifact
              Comments

              This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the artifact as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the artifact is presumed to be the predominant language in the place the artifact was created).

              Control0..1
              TypeExtension(Artifact Description) (Extension Type: markdown)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-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())
              42. Group.modifierExtension
              Definition

              An Extension

              ShortExtension
              Control1..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
              Summaryfalse
              Invariantsele-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())
              SlicingThis element introduces a set of slices on Group.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 44. Group.modifierExtension:status
                Slice Namestatus
                Definition

                The status of this artifact. Enables tracking the life-cycle of the content.

                Shortdraft | active | retired | unknown
                Control1..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Artifact Status) (Extension Type: code)
                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration
                Must Supporttrue
                Summaryfalse
                Invariantsele-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())
                46. Group.identifier
                Definition

                A unique business identifier for this group.

                ShortUnique id
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..*
                TypeIdentifier
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                Allows the group to be referenced from external specifications.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                48. Group.active
                Definition

                Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

                ShortWhether this group's record is in active use
                Control0..1
                Typeboolean
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                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).

                Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                50. Group.type
                Definition

                Identifies the broad classification of the kind of resources the group includes.

                Shortperson | animal | practitioner | device | medication | substance
                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.).

                Control1..1
                BindingThe codes SHALL be taken from GroupType
                (required to http://hl7.org/fhir/ValueSet/group-type|4.0.1)

                Types of resources that are part of group.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Requirements

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

                Fixed Valueperson
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                52. 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.

                ShortDescriptive or actual
                Control1..1
                This element is affected by the following invariants: grp-1
                Typeboolean
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                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.

                Fixed Valuefalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                54. Group.code
                Definition

                Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.

                ShortKind of Group members
                Comments

                This would generally be omitted for Person resources.

                Control0..1
                Binding

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

                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                56. Group.name
                Definition

                A label assigned to the group for human identification and communication.

                ShortLabel for Group
                Control1..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Requirements

                Used to identify the group in human communication.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                58. Group.quantity
                Definition

                A count of the number of resource instances that are part of the group.

                ShortNumber of members
                Comments

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

                Control0..1
                TypeunsignedInt
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Group size is a common defining characteristic.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                60. Group.managingEntity
                Definition

                Entity responsible for defining and maintaining Group characteristics and/or registered members.

                ShortEntity that is the custodian of the Group's definition
                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.

                Control0..1
                TypeReference(Organization, RelatedPerson, Practitioner, PractitionerRole)
                Is Modifierfalse
                Must Supporttrue
                Must Support TypesNo must-support rules about the choice of types/profiles
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                62. Group.managingEntity.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                64. Group.managingEntity.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.

                ShortAdditional content defined by implementations
                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.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-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())
                SlicingThis element introduces a set of slices on Group.managingEntity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 66. Group.managingEntity.extension:profile
                  Slice Nameprofile
                  Definition

                  A reference to a resource, canonical resource, or non-FHIR resource.

                  ShortThe artifact
                  Control0..1
                  TypeExtension(Artifact Reference) (Extension Type: Choice of: Reference(Resource), canonical, uri)
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-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())
                  68. Group.managingEntity.extension:profile.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  70. Group.managingEntity.extension:profile.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control0..0
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-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())
                  SlicingThis element introduces a set of slices on Group.managingEntity.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 72. Group.managingEntity.extension:profile.url
                    Definition

                    Source of the definition for the extension code - a logical name or a URL.

                    Shortidentifies the meaning of the extension
                    Comments

                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/artifact-reference
                    74. Group.managingEntity.extension:profile.value[x]
                    Definition

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                    ShortValue of extension
                    Control1..1
                    Typecanonical
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    76. Group.managingEntity.reference
                    Definition

                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                    ShortLiteral reference, Relative, internal or absolute URL
                    Comments

                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                    Control0..1
                    This element is affected by the following invariants: ref-1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    78. Group.managingEntity.type
                    Definition

                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                    ShortType the reference refers to (e.g. "Patient")
                    Comments

                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from ResourceType
                    (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                    Aa resource (or, for logical models, the URI of the logical model).

                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    80. Group.managingEntity.identifier
                    Definition

                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                    ShortLogical reference, when literal reference is not known
                    Comments

                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..1
                    TypeIdentifier
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    82. Group.managingEntity.display
                    Definition

                    Plain text narrative that identifies the resource in addition to the resource reference.

                    ShortText alternative for the resource
                    Comments

                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    84. Group.characteristic
                    Definition

                    Identifies traits whose presence r absence is shared by members of the group.

                    ShortInclude / Exclude group members by Trait
                    Comments

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

                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Requirements

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

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. 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.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    88. 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.

                    ShortAdditional content defined by implementations
                    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.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-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())
                    90. 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).

                    ShortExtensions that cannot be ignored even if unrecognized
                    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.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    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.

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-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())
                    92. Group.characteristic.code
                    Definition

                    A code that identifies the kind of trait being asserted.

                    ShortKind of characteristic
                    Control1..1
                    Binding

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

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Need a formal way of identifying the characteristic being described.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    94. Group.characteristic.value[x]
                    Definition

                    The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

                    ShortValue held by characteristic
                    Comments

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

                    Control1..1
                    Binding

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

                    TypeChoice of: CodeableConcept, boolean, Quantity, Range, Reference
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Must Support TypesNo must-support rules about the choice of types/profiles
                    Summaryfalse
                    Requirements

                    The value of the characteristic is what determines group membership.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    SlicingThis element introduces a set of slices on Group.characteristic.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • type @ $this
                    • 96. Group.characteristic.value[x]:valueReference
                      Slice NamevalueReference
                      Definition

                      The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

                      ShortValue held by characteristic
                      Comments

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

                      Control0..1
                      TypeReference
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      The value of the characteristic is what determines group membership.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. Group.characteristic.value[x]:valueReference.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      100. Group.characteristic.value[x]:valueReference.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.

                      ShortAdditional content defined by implementations
                      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.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-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())
                      SlicingThis element introduces a set of slices on Group.characteristic.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 102. Group.characteristic.value[x]:valueReference.extension:valueCanonical
                        Slice NamevalueCanonical
                        Definition

                        Instances that conform to the referenced profile are included (or excluded if characteristic.exclude is true) in the cohort.

                        ShortInstances that conform to the referenced profile
                        Control0..1
                        TypeExtension(CRMI Group Characteristic Value Canonical Extension) (Extension Type: canonical)
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Invariantsele-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())
                        104. Group.characteristic.value[x]:valueReference.reference
                        Definition

                        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                        ShortLiteral reference, Relative, internal or absolute URL
                        Comments

                        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                        Control0..1
                        This element is affected by the following invariants: ref-1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        106. Group.characteristic.value[x]:valueReference.type
                        Definition

                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                        ShortType the reference refers to (e.g. "Patient")
                        Comments

                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                        Control0..1
                        BindingUnless not suitable, these codes SHALL be taken from ResourceType
                        (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                        Aa resource (or, for logical models, the URI of the logical model).

                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        108. Group.characteristic.value[x]:valueReference.identifier
                        Definition

                        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                        ShortLogical reference, when literal reference is not known
                        Comments

                        When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                        When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1
                        TypeIdentifier
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        110. Group.characteristic.value[x]:valueReference.display
                        Definition

                        Plain text narrative that identifies the resource in addition to the resource reference.

                        ShortText alternative for the resource
                        Comments

                        This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        112. Group.characteristic.exclude
                        Definition

                        If true, indicates the characteristic is one that is NOT held by members of the group.

                        ShortGroup includes or excludes
                        Comments

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

                        Control1..1
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Requirements

                        Sometimes group membership is determined by characteristics not possessed.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        114. Group.characteristic.period
                        Definition

                        The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.

                        ShortPeriod over which characteristic is tested
                        Control0..1
                        TypePeriod
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        116. Group.member
                        Definition

                        Identifies the resource instances that are members of the group.

                        ShortWho or what is in group
                        Control0..*
                        This element is affected by the following invariants: grp-1
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Requirements

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

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        118. 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.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        120. 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.

                        ShortAdditional content defined by implementations
                        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.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-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())
                        122. 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).

                        ShortExtensions that cannot be ignored even if unrecognized
                        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.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        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.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-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())
                        124. 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.

                        ShortReference to the group member
                        Control1..1
                        TypeReference(Patient, Practitioner, PractitionerRole, Device, Medication, Substance, Group)
                        Is Modifierfalse
                        Must Supporttrue
                        Must Support TypesNo must-support rules about the choice of types/profiles
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        126. Group.member.entity.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        128. Group.member.entity.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.

                        ShortAdditional content defined by implementations
                        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.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-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())
                        SlicingThis element introduces a set of slices on Group.member.entity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 130. Group.member.entity.extension:profile
                          Slice Nameprofile
                          Definition

                          A reference to a resource, canonical resource, or non-FHIR resource.

                          ShortThe artifact
                          Control0..1
                          TypeExtension(Artifact Reference) (Extension Type: Choice of: Reference(Resource), canonical, uri)
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Invariantsele-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())
                          132. Group.member.entity.extension:profile.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          134. Group.member.entity.extension:profile.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..0
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-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())
                          SlicingThis element introduces a set of slices on Group.member.entity.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 136. Group.member.entity.extension:profile.url
                            Definition

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            Comments

                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/artifact-reference
                            138. Group.member.entity.extension:profile.value[x]
                            Definition

                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                            ShortValue of extension
                            Control1..1
                            Typecanonical
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            gdf-2: Reference must be to a structure definition (resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition'))
                            140. Group.member.entity.extension:nonCanonicalReference
                            Slice NamenonCanonicalReference
                            Definition

                            Create a reference, following canonical reference semantics, to an artifact that uses the artifact-url and artifact-version extensions to provide a canonical identifier.

                            ShortThe artifact
                            Control0..1
                            TypeExtension(Artifact URI Reference) (Extension Type: uri)
                            Is Modifierfalse
                            Must Supporttrue
                            Summaryfalse
                            Invariantsele-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())
                            142. Group.member.entity.reference
                            Definition

                            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                            ShortLiteral reference, Relative, internal or absolute URL
                            Comments

                            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                            Control0..1
                            This element is affected by the following invariants: ref-1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            144. Group.member.entity.type
                            Definition

                            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                            ShortType the reference refers to (e.g. "Patient")
                            Comments

                            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                            Control0..1
                            BindingUnless not suitable, these codes SHALL be taken from ResourceType
                            (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                            Aa resource (or, for logical models, the URI of the logical model).

                            Typeuri
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            146. Group.member.entity.identifier
                            Definition

                            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                            ShortLogical reference, when literal reference is not known
                            Comments

                            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                            NoteThis is a business identifier, not a resource identifier (see discussion)
                            Control0..1
                            TypeIdentifier
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            148. Group.member.entity.display
                            Definition

                            Plain text narrative that identifies the resource in addition to the resource reference.

                            ShortText alternative for the resource
                            Comments

                            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            150. Group.member.period
                            Definition

                            The period that the member was in the group, if known.

                            ShortPeriod member belonged to the group
                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

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

                            Meaning if MissingThe member is in the group at this time
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            152. Group.member.inactive
                            Definition

                            A flag to indicate that the member is no longer in the group, but previously may have been a member.

                            ShortIf member is no longer in group
                            Control0..1
                            Typeboolean
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

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

                            Meaning if MissingMembers are considered active unless explicitly specified otherwise
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))