FHIR Release 3 (STU)
AdministrationThis page is part of the FHIR Specification (v3.0.2: STU 3). 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 R3 R2
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Patient, Practitioner |
StructureDefinition for group
{
"resourceType": "StructureDefinition",
"id": "Group",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Group",
"name": "Group",
"status": "draft",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Group Resource",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Group",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "Group",
"path": "Group",
"short": "Group of multiple entities",
"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.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "grp-1",
"severity": "error",
"human": "Can only have members if group is \"actual\"",
"expression": "member.empty() or (actual = true)",
"xpath": "f:actual/@value=true() or not(exists(f:member))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"
},
{
"identity": "w5",
"map": "administrative.group"
}
]
},
{
"id": "Group.id",
"path": "Group.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Group.meta",
"path": "Group.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "Group.implicitRules",
"path": "Group.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "Group.language",
"path": "Group.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "Group.text",
"path": "Group.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comment": "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 in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Group.contained",
"path": "Group.contained",
"short": "Contained, inline Resources",
"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.",
"comment": "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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Group.extension",
"path": "Group.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Group.modifierExtension",
"path": "Group.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Group.identifier",
"path": "Group.identifier",
"short": "Unique id",
"definition": "A unique business identifier for this group.",
"requirements": "Allows the group to be referenced from external specifications.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Group.active",
"path": "Group.active",
"short": "Whether this group's record is in active use",
"definition": "Indicates whether the record for the group is available for use or is merely being retained for historical purposes.",
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Group.type",
"path": "Group.type",
"short": "person | animal | practitioner | device | medication | substance",
"definition": "Identifies the broad classification of the kind of resources the group includes.",
"comment": "Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medicaiton or Substance for the other types.).",
"requirements": "Identifies what type of resources the group is made up of.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GroupType"
}
],
"strength": "required",
"description": "Types of resources that are part of group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/group-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\""
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Group.actual",
"path": "Group.actual",
"short": "Descriptive or 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.",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"condition": [
"grp-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "true: ./determinerCode=\"GRP\" false: ./determinerCode=\"GRP_KIND\""
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Group.code",
"path": "Group.code",
"short": "Kind of Group members",
"definition": "Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.",
"comment": "This would generally be omitted for Person resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GroupKind"
}
],
"strength": "example",
"description": "Kind of particular resource; e.g. cow, syringe, lake, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Group.name",
"path": "Group.name",
"short": "Label for Group",
"definition": "A label assigned to the group for human identification and communication.",
"requirements": "Used to identify the group in human communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./name[type=\"ST\"]"
}
]
},
{
"id": "Group.quantity",
"path": "Group.quantity",
"short": "Number of members",
"definition": "A count of the number of resource instances that are part of the group.",
"comment": "Note that the quantity may be less than the number of members if some of the members are not active.",
"requirements": "Group size is a common defining characteristic.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./quantity"
}
]
},
{
"id": "Group.characteristic",
"path": "Group.characteristic",
"short": "Trait of group members",
"definition": "Identifies the traits shared by members of the group.",
"comment": "All the identified characteristics must be true for an entity to a member of the group.",
"requirements": "Needs to be a generic mechanism for identifying what individuals can be part of a group.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"
}
]
},
{
"id": "Group.characteristic.id",
"path": "Group.characteristic.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Group.characteristic.extension",
"path": "Group.characteristic.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Group.characteristic.modifierExtension",
"path": "Group.characteristic.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comment": "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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Group.characteristic.code",
"path": "Group.characteristic.code",
"short": "Kind of characteristic",
"definition": "A code that identifies the kind of trait being asserted.",
"requirements": "Need a formal way of identifying the characteristic being described.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GroupCharacteristicKind"
}
],
"strength": "example",
"description": "List of characteristics used to describe group members; e.g. gender, age, owner, location, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"id": "Group.characteristic.value[x]",
"path": "Group.characteristic.value[x]",
"short": "Value held by characteristic",
"definition": "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.",
"comment": "For Range, it means members of the group have a value that falls somewhere within the specified range.",
"requirements": "The value of the characteristic is what determines group membership.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "boolean"
},
{
"code": "Quantity"
},
{
"code": "Range"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GroupCharacteristicValue"
}
],
"strength": "example",
"description": "Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./value"
}
]
},
{
"id": "Group.characteristic.exclude",
"path": "Group.characteristic.exclude",
"short": "Group includes or excludes",
"definition": "If true, indicates the characteristic is one that is NOT held by members of the group.",
"comment": "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.",
"requirements": "Sometimes group membership is determined by characteristics not possessed.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "./valueNegationInd"
}
]
},
{
"id": "Group.characteristic.period",
"path": "Group.characteristic.period",
"short": "Period over which characteristic is tested",
"definition": "The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"id": "Group.member",
"path": "Group.member",
"short": "Who or what is in group",
"definition": "Identifies the resource instances that are members of the group.",
"requirements": "Often the only thing of interest about a group is \"who's in it\".",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"grp-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"
}
]
},
{
"id": "Group.member.id",
"path": "Group.member.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Group.member.extension",
"path": "Group.member.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Group.member.modifierExtension",
"path": "Group.member.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comment": "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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Group.member.entity",
"path": "Group.member.entity",
"short": "Reference to the group member",
"definition": "A reference to the entity that is a member of the group. Must be consistent with Group.type.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
]
},
{
"id": "Group.member.period",
"path": "Group.member.period",
"short": "Period member belonged to the group",
"definition": "The period that the member was in the group, if known.",
"requirements": "Need to track who was in a group at a particular time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"meaningWhenMissing": "The member is in the group at this time"
},
{
"id": "Group.member.inactive",
"path": "Group.member.inactive",
"short": "If member is no longer in group",
"definition": "A flag to indicate that the member is no longer in the group, but previously may have been a member.",
"requirements": "Sometimes you don't know when someone stopped being in a group, but not when.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false
}
]
},
"differential": {
"element": [
{
"id": "Group",
"path": "Group",
"short": "Group of multiple entities",
"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.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "grp-1",
"severity": "error",
"human": "Can only have members if group is \"actual\"",
"expression": "member.empty() or (actual = true)",
"xpath": "f:actual/@value=true() or not(exists(f:member))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"
},
{
"identity": "w5",
"map": "administrative.group"
}
]
},
{
"id": "Group.identifier",
"path": "Group.identifier",
"short": "Unique id",
"definition": "A unique business identifier for this group.",
"requirements": "Allows the group to be referenced from external specifications.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Group.active",
"path": "Group.active",
"short": "Whether this group's record is in active use",
"definition": "Indicates whether the record for the group is available for use or is merely being retained for historical purposes.",
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Group.type",
"path": "Group.type",
"short": "person | animal | practitioner | device | medication | substance",
"definition": "Identifies the broad classification of the kind of resources the group includes.",
"comment": "Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medicaiton or Substance for the other types.).",
"requirements": "Identifies what type of resources the group is made up of.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GroupType"
}
],
"strength": "required",
"description": "Types of resources that are part of group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/group-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\""
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Group.actual",
"path": "Group.actual",
"short": "Descriptive or 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.",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"condition": [
"grp-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "true: ./determinerCode=\"GRP\" false: ./determinerCode=\"GRP_KIND\""
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Group.code",
"path": "Group.code",
"short": "Kind of Group members",
"definition": "Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.",
"comment": "This would generally be omitted for Person resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GroupKind"
}
],
"strength": "example",
"description": "Kind of particular resource; e.g. cow, syringe, lake, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Group.name",
"path": "Group.name",
"short": "Label for Group",
"definition": "A label assigned to the group for human identification and communication.",
"requirements": "Used to identify the group in human communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./name[type=\"ST\"]"
}
]
},
{
"id": "Group.quantity",
"path": "Group.quantity",
"short": "Number of members",
"definition": "A count of the number of resource instances that are part of the group.",
"comment": "Note that the quantity may be less than the number of members if some of the members are not active.",
"requirements": "Group size is a common defining characteristic.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./quantity"
}
]
},
{
"id": "Group.characteristic",
"path": "Group.characteristic",
"short": "Trait of group members",
"definition": "Identifies the traits shared by members of the group.",
"comment": "All the identified characteristics must be true for an entity to a member of the group.",
"requirements": "Needs to be a generic mechanism for identifying what individuals can be part of a group.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"
}
]
},
{
"id": "Group.characteristic.code",
"path": "Group.characteristic.code",
"short": "Kind of characteristic",
"definition": "A code that identifies the kind of trait being asserted.",
"requirements": "Need a formal way of identifying the characteristic being described.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GroupCharacteristicKind"
}
],
"strength": "example",
"description": "List of characteristics used to describe group members; e.g. gender, age, owner, location, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"id": "Group.characteristic.value[x]",
"path": "Group.characteristic.value[x]",
"short": "Value held by characteristic",
"definition": "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.",
"comment": "For Range, it means members of the group have a value that falls somewhere within the specified range.",
"requirements": "The value of the characteristic is what determines group membership.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "boolean"
},
{
"code": "Quantity"
},
{
"code": "Range"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GroupCharacteristicValue"
}
],
"strength": "example",
"description": "Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./value"
}
]
},
{
"id": "Group.characteristic.exclude",
"path": "Group.characteristic.exclude",
"short": "Group includes or excludes",
"definition": "If true, indicates the characteristic is one that is NOT held by members of the group.",
"comment": "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.",
"requirements": "Sometimes group membership is determined by characteristics not possessed.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "./valueNegationInd"
}
]
},
{
"id": "Group.characteristic.period",
"path": "Group.characteristic.period",
"short": "Period over which characteristic is tested",
"definition": "The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"id": "Group.member",
"path": "Group.member",
"short": "Who or what is in group",
"definition": "Identifies the resource instances that are members of the group.",
"requirements": "Often the only thing of interest about a group is \"who's in it\".",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"grp-1"
],
"mapping": [
{
"identity": "rim",
"map": "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"
}
]
},
{
"id": "Group.member.entity",
"path": "Group.member.entity",
"short": "Reference to the group member",
"definition": "A reference to the entity that is a member of the group. Must be consistent with Group.type.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
]
},
{
"id": "Group.member.period",
"path": "Group.member.period",
"short": "Period member belonged to the group",
"definition": "The period that the member was in the group, if known.",
"requirements": "Need to track who was in a group at a particular time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"meaningWhenMissing": "The member is in the group at this time"
},
{
"id": "Group.member.inactive",
"path": "Group.member.inactive",
"short": "If member is no longer in group",
"definition": "A flag to indicate that the member is no longer in the group, but previously may have been a member.",
"requirements": "Sometimes you don't know when someone stopped being in a group, but not when.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change