Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_Group_R4B

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Group Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_Group_R4B

This cross-version profile allows STU3 Group content to be represented via FHIR R4B Group resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group(4.3.0) Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group 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 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error Group.implicitRules, Group.modifierExtension, Group.type, Group.actual All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Group.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group(4.3.0) Group of multiple entities
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 string STU3: name
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
... characteristic
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value 0..1 Range STU3: value additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.characteristic.value
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.characteristic.period
... member
.... entity
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entity 0..1 Reference(Resource) STU3: entity
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.member.period

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group(4.3.0) Group of multiple entities
Constraints: grp-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Unique id
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 0..1 boolean Whether this group's record is in active use
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
... actual ΣC 1..1 boolean Descriptive or actual
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name Σ 0..1 string Label for Group
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:name 0..1 string STU3: name
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Constraints: ext-1
.... value 0..1 string Primitive value for string
Max Length:1048576
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity Σ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
... characteristic 0..* BackboneElement Include / Exclude group members by Trait
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:value 0..1 Range STU3: value additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.characteristic.value
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.characteristic.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... member C 0..* BackboneElement Who or what is in group
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... entity 1..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:entity 0..1 Reference(Resource) STU3: entity
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... period 0..1 Period Period member belonged to the group
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.member.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Group.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Group.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Group.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Group.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Group.identifier.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Group.type Base required GroupType 📍4.3.0 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.member.entity.​type Base extensible ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group 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 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning Group.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Group.meta, Group.meta.extension, Group.meta.extension:meta, Group.meta.versionId, Group.meta.lastUpdated, Group.meta.source, Group.meta.profile, Group.meta.security, Group.meta.tag, Group.implicitRules, Group.language, Group.text, Group.text.extension, Group.text.extension:text, Group.text.status, Group.text.div, Group.extension, Group.modifierExtension, Group.identifier, Group.identifier.extension, Group.identifier.extension:identifier, Group.identifier.use, Group.identifier.type, Group.identifier.system, Group.identifier.value, Group.identifier.period, Group.identifier.assigner, Group.active, Group.type, Group.actual, Group.code, Group.name, Group.name.extension, Group.name.extension:name, Group.quantity, Group.managingEntity, Group.characteristic, Group.characteristic.extension, Group.characteristic.extension:value, Group.characteristic.modifierExtension, Group.characteristic.code, Group.characteristic.value[x], Group.characteristic.exclude, Group.characteristic.period, Group.characteristic.period.extension, Group.characteristic.period.extension:period, Group.characteristic.period.start, Group.characteristic.period.end, Group.member, Group.member.extension, Group.member.modifierExtension, Group.member.entity, Group.member.entity.extension, Group.member.entity.extension:entity, Group.member.entity.reference, Group.member.entity.type, Group.member.entity.identifier, Group.member.entity.display, Group.member.period, Group.member.period.extension, Group.member.period.extension:period, Group.member.period.start, Group.member.period.end, Group.member.inactive All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Group.meta.extension, Group.meta.extension:meta, Group.text.extension, Group.text.extension:text, Group.extension, Group.modifierExtension, Group.identifier.extension, Group.identifier.extension:identifier, Group.name.extension, Group.name.extension:name, Group.characteristic.extension, Group.characteristic.extension:value, Group.characteristic.modifierExtension, Group.characteristic.period.extension, Group.characteristic.period.extension:period, Group.member.extension, Group.member.modifierExtension, Group.member.entity.extension, Group.member.entity.extension:entity, Group.member.period.extension, Group.member.period.extension:period Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)
txt-1 error Group.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Group.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group(4.3.0) Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group 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 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error Group.implicitRules, Group.modifierExtension, Group.type, Group.actual All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Group.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group(4.3.0) Group of multiple entities
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 string STU3: name
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
... characteristic
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value 0..1 Range STU3: value additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.characteristic.value
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.characteristic.period
... member
.... entity
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entity 0..1 Reference(Resource) STU3: entity
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.member.period

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group(4.3.0) Group of multiple entities
Constraints: grp-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Unique id
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 0..1 boolean Whether this group's record is in active use
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
... actual ΣC 1..1 boolean Descriptive or actual
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name Σ 0..1 string Label for Group
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:name 0..1 string STU3: name
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Constraints: ext-1
.... value 0..1 string Primitive value for string
Max Length:1048576
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity Σ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
... characteristic 0..* BackboneElement Include / Exclude group members by Trait
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:value 0..1 Range STU3: value additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.characteristic.value
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.characteristic.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... member C 0..* BackboneElement Who or what is in group
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... entity 1..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:entity 0..1 Reference(Resource) STU3: entity
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... period 0..1 Period Period member belonged to the group
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Group.member.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Group.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Group.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Group.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Group.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Group.identifier.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Group.type Base required GroupType 📍4.3.0 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.member.entity.​type Base extensible ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group 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 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning Group.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Group.meta, Group.meta.extension, Group.meta.extension:meta, Group.meta.versionId, Group.meta.lastUpdated, Group.meta.source, Group.meta.profile, Group.meta.security, Group.meta.tag, Group.implicitRules, Group.language, Group.text, Group.text.extension, Group.text.extension:text, Group.text.status, Group.text.div, Group.extension, Group.modifierExtension, Group.identifier, Group.identifier.extension, Group.identifier.extension:identifier, Group.identifier.use, Group.identifier.type, Group.identifier.system, Group.identifier.value, Group.identifier.period, Group.identifier.assigner, Group.active, Group.type, Group.actual, Group.code, Group.name, Group.name.extension, Group.name.extension:name, Group.quantity, Group.managingEntity, Group.characteristic, Group.characteristic.extension, Group.characteristic.extension:value, Group.characteristic.modifierExtension, Group.characteristic.code, Group.characteristic.value[x], Group.characteristic.exclude, Group.characteristic.period, Group.characteristic.period.extension, Group.characteristic.period.extension:period, Group.characteristic.period.start, Group.characteristic.period.end, Group.member, Group.member.extension, Group.member.modifierExtension, Group.member.entity, Group.member.entity.extension, Group.member.entity.extension:entity, Group.member.entity.reference, Group.member.entity.type, Group.member.entity.identifier, Group.member.entity.display, Group.member.period, Group.member.period.extension, Group.member.period.extension:period, Group.member.period.start, Group.member.period.end, Group.member.inactive All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Group.meta.extension, Group.meta.extension:meta, Group.text.extension, Group.text.extension:text, Group.extension, Group.modifierExtension, Group.identifier.extension, Group.identifier.extension:identifier, Group.name.extension, Group.name.extension:name, Group.characteristic.extension, Group.characteristic.extension:value, Group.characteristic.modifierExtension, Group.characteristic.period.extension, Group.characteristic.period.extension:period, Group.member.extension, Group.member.modifierExtension, Group.member.entity.extension, Group.member.entity.extension:entity, Group.member.period.extension, Group.member.period.extension:period Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)
txt-1 error Group.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Group.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron