This page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
FHIR Infrastructure Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/actualgroup
Enforces an actual group, rather than a definitional group
This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Group.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Group | I | 1..1 | Group | Group of multiple entities | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique id | ||||
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 | ΣI | 1..1 | boolean | Descriptive or actual Fixed Value: true | ||||
code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
name | Σ | 0..1 | string | Label for Group | ||||
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 | ||||
member | I | 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entity | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |||||
period | 0..1 | Period | Period member belonged to the group | |||||
inactive | 0..1 | boolean | If member is no longer in group | |||||
Documentation for this format |
<!-- Actual Group --> <Group xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 0..* Identifier Unique id --></identifier> <active value="[boolean]"/><!-- 0..1 Whether this group's record is in active use --> <type value="[code]"/><!-- 1..1 person | animal | practitioner | device | medication | substance --> <actual value="[boolean]"/><!-- 1..1 Descriptive or actual --> <code><!-- 0..1 CodeableConcept Kind of Group members --></code> <name value="[string]"/><!-- 0..1 Label for Group --> <quantity value="[unsignedInt]"/><!-- 0..1 Number of members --> <managingEntity><!-- 0..1 Reference(Organization) Entity that is the custodian of the Group's definition --></managingEntity> <characteristic> 0..0 BackboneElement <!-- 0..0 Include / Exclude group members by Trait --> </characteristic> <member> 0..* BackboneElement <!-- 0..* Who or what is in group --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <entity><!-- 1..1 Reference(Patient) Reference to the group member --></entity> <period><!-- 0..1 Period Period member belonged to the group --></period> <inactive value="[boolean]"/><!-- 0..1 If member is no longer in group --> </member> </Group>
{ // Actual Group // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], // C?Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "identifier" : [{ Identifier }], // C?Unique id "active" : <boolean>, // C?Whether this group's record is in active use "type" : "<code>", // C? R! person | animal | practitioner | device | medication | substance "actual" : true, // C? R! "code" : { CodeableConcept }, // C?Kind of Group members "name" : "<string>", // C?Label for Group "quantity" : "<unsignedInt>", // C?Number of members "managingEntity" : { Reference(Organization) }, // C?Entity that is the custodian of the Group's definition "member" : [{ BackboneElement }] // C?Who or what is in group }
This structure is derived from Group.
Differential View
This structure is derived from Group.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | 1..1 | Group | Group of multiple entities | |
actual | 1..1 | boolean | Descriptive or actual Fixed Value: true | |
characteristic | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Group | I | 1..1 | Group | Group of multiple entities | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique id | ||||
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 | ΣI | 1..1 | boolean | Descriptive or actual Fixed Value: true | ||||
code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
name | Σ | 0..1 | string | Label for Group | ||||
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 | ||||
member | I | 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entity | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | |||||
period | 0..1 | Period | Period member belonged to the group | |||||
inactive | 0..1 | boolean | If member is no longer in group | |||||
Documentation for this format |
XML Template
<!-- Actual Group --> <Group xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 0..* Identifier Unique id --></identifier> <active value="[boolean]"/><!-- 0..1 Whether this group's record is in active use --> <type value="[code]"/><!-- 1..1 person | animal | practitioner | device | medication | substance --> <actual value="[boolean]"/><!-- 1..1 Descriptive or actual --> <code><!-- 0..1 CodeableConcept Kind of Group members --></code> <name value="[string]"/><!-- 0..1 Label for Group --> <quantity value="[unsignedInt]"/><!-- 0..1 Number of members --> <managingEntity><!-- 0..1 Reference(Organization) Entity that is the custodian of the Group's definition --></managingEntity> <characteristic> 0..0 BackboneElement <!-- 0..0 Include / Exclude group members by Trait --> </characteristic> <member> 0..* BackboneElement <!-- 0..* Who or what is in group --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <entity><!-- 1..1 Reference(Patient) Reference to the group member --></entity> <period><!-- 0..1 Period Period member belonged to the group --></period> <inactive value="[boolean]"/><!-- 0..1 If member is no longer in group --> </member> </Group>
JSON Template
{ // Actual Group // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], // C?Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "identifier" : [{ Identifier }], // C?Unique id "active" : <boolean>, // C?Whether this group's record is in active use "type" : "<code>", // C? R! person | animal | practitioner | device | medication | substance "actual" : true, // C? R! "code" : { CodeableConcept }, // C?Kind of Group members "name" : "<string>", // C?Label for Group "quantity" : "<unsignedInt>", // C?Number of members "managingEntity" : { Reference(Organization) }, // C?Entity that is the custodian of the Group's definition "member" : [{ BackboneElement }] // C?Who or what is in group }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
Group.language | Common Languages | preferred | Common Languages |
Group.type | GroupType | required | GroupType |
Group.code | ?ext | example | |
Group.characteristic.code | ?ext | example | |
Group.characteristic.value[x] | ?ext | example |