. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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
Profile for group
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"group-definitions.html#Group\"><b>Group</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A unique business identifier for this group.\" class=\"dict\" href=\"group-definitions.html#Group.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique id<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identifies the broad classification of the kind of resources the group includes.\" class=\"dict\" href=\"group-definitions.html#Group.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"group-type.html\">person | animal | practitioner | device | medication | substance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.\" class=\"dict\" href=\"group-definitions.html#Group.actual\"><b>actual</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Descriptive or actual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc.\" class=\"dict\" href=\"group-definitions.html#Group.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Kind of Group members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A label assigned to the group for human identification and communication.\" class=\"dict\" href=\"group-definitions.html#Group.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Label for Group<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A count of the number of resource instances that are part of the group.\" class=\"dict\" href=\"group-definitions.html#Group.quantity\"><b>quantity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Number of members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the traits shared by members of the group.\" class=\"dict\" href=\"group-definitions.html#Group.characteristic\"><b>characteristic</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Trait of group members --></span>\r\n <<a title=\"A code that identifies the kind of trait being asserted.\" class=\"dict\" href=\"group-definitions.html#Group.characteristic.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Kind of characteristic</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The value of the trait that holds (or does not hold - see 'exclude') for members of the group.\" class=\"dict\" href=\"group-definitions.html#Group.characteristic.value_x_\"><b>value[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#Quantity\">Quantity</a>|<a href=\"datatypes.html#Range\">Range</a></span> <span style=\"color: navy\">Value held by characteristic</span><span style=\"color: Gray\"> --></span></value[x]>\r\n <<a title=\"If true, indicates the characteristic is one that is NOT held by members of the group (this element modifies the meaning of other elements)\" class=\"dict\" href=\"group-definitions.html#Group.characteristic.exclude\"><span style=\"text-decoration: underline\"><b>exclude</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Group includes or excludes</span><span style=\"color: Gray\"> --></span>\r\n </characteristic>\r\n <<a title=\"Identifies the resource instances that are members of the group.\" class=\"dict\" href=\"group-definitions.html#Group.member\"><b>member</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"medication.html#Medication\">Medication</a>|<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Who is in group</span><span style=\"color: Gray\"> --></span></member>\r\n</Group>\r\n</pre></div>"
},
"name": "group",
"publisher": "FHIR Project",
"description": "Basic Profile. 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.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Use Cases The group resource is used in one of two ways:\r\n\r\n* To define a group of specific people, animals, devices, etc. that is being tracked, examined or otherwise referenced as part of healthcare-related activities\r\n* To define a set of *possible* people, animals, devices, etc. that are of interest for some intended future healthcare-related activities\r\nExamples of the former could include group therapy or treatment sessions, exposed entities tracked as part of public health, etc. The latter might be used to define expected subjects for a clinical study.\r\n\r\nBoth use cases are handled by a single resource because the data elements captured tend to be similar.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Group",
"publish": true,
"element": [
{
"path": "Group",
"definition": {
"short": "Group of multiple entities",
"formal": "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": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "1",
"name": "No members for non-actual",
"severity": "error",
"human": "Can only have members if group is \"actual\"",
"xpath": "f:actual/@value='true' or not(exists(f:member))"
},
{
"key": "4",
"name": "No more members than quantity",
"severity": "error",
"human": "Can't have more members associated with the group than the value specified for \"quantity\"",
"xpath": "not(f:quantity) or not(f:member) or not(f:quantity>count(f:member))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"
}
]
}
},
{
"path": "Group.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Group.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Group.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Group.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Group.identifier",
"definition": {
"short": "Unique id",
"formal": "A unique business identifier for this group.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
}
]
}
},
{
"path": "Group.type",
"definition": {
"short": "person | animal | practitioner | device | medication | substance",
"formal": "Identifies the broad classification of the kind of resources the group includes.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "GroupType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/group-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "person: ./classCode=\"PSN\"\n\nanimal: ./classCode=\"ANM\"\n\ndevice: ./classCode=\"DEV\"\n\nmedication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"]\n\nfood: ./classCode=\"FOOD\""
}
]
}
},
{
"path": "Group.actual",
"definition": {
"short": "Descriptive or actual",
"formal": "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "true: ./determinerCode=\"GRP\"\n\nfalse: ./determinerCode=\"GRP_KIND\""
}
]
}
},
{
"path": "Group.code",
"definition": {
"short": "Kind of Group members",
"formal": "Provides a specific type of resource the group includes. E.g. \"cow\", \"syringe\", etc.",
"comments": "This would generally be omitted for Person resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "GroupKind",
"isExtensible": true,
"conformance": "preferred",
"description": "Kind of particular resource. E.g. cow, syringe, lake, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
}
},
{
"path": "Group.name",
"definition": {
"short": "Label for Group",
"formal": "A label assigned to the group for human identification and communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./name[type=\"ST\"]"
}
]
}
},
{
"path": "Group.quantity",
"definition": {
"short": "Number of members",
"formal": "A count of the number of resource instances that are part of the group.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./quantity"
}
]
}
},
{
"path": "Group.characteristic",
"definition": {
"short": "Trait of group members",
"formal": "Identifies the traits shared by members of the group.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"
}
]
}
},
{
"path": "Group.characteristic.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Group.characteristic.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Group.characteristic.code",
"definition": {
"short": "Kind of characteristic",
"formal": "A code that identifies the kind of trait being asserted.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "GroupCharacteristicKind",
"isExtensible": true,
"conformance": "preferred",
"description": "List of characteristics used to describe group members. E.g. gender, age, owner, location, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
}
},
{
"path": "Group.characteristic.value[x]",
"definition": {
"short": "Value held by characteristic",
"formal": "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.",
"comments": "For Range, it means members of the group have a value that falls somewhere within the specified range.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "boolean"
},
{
"code": "Quantity"
},
{
"code": "Range"
}
],
"isModifier": false,
"binding": {
"name": "GroupCharacteristicValue",
"isExtensible": true,
"conformance": "preferred",
"description": "Value of descriptive member characteristic. E.g. red, male, pneumonia, caucasian, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./value"
}
]
}
},
{
"path": "Group.characteristic.exclude",
"definition": {
"short": "Group includes or excludes",
"formal": "If true, indicates the characteristic is one that is NOT held by members of the group.",
"comments": "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "./valueNegationInd"
}
]
}
},
{
"path": "Group.member",
"definition": {
"short": "Who is in group",
"formal": "Identifies the resource instances that are members of the group.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"constraint": [
{
"key": "3",
"name": "Group member type agreement",
"severity": "error",
"human": "Member resource types SHALL agree with group type",
"xpath": "lower-case(f:type/@value)=parent::f:Group/f:type/@value or (f:type/@value='Patient' and parent::f:Group/f:type/@value=('animal','person'))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "actual",
"type": "token",
"documentation": "Descriptive or actual",
"xpath": "f:Group/f:actual"
},
{
"name": "characteristic",
"type": "token",
"documentation": "Kind of characteristic",
"xpath": "f:Group/f:characteristic/f:code"
},
{
"name": "characteristic-value",
"type": "composite",
"documentation": "A composite of both characteristic and value"
},
{
"name": "code",
"type": "token",
"documentation": "The kind of resources contained",
"xpath": "f:Group/f:code"
},
{
"name": "exclude",
"type": "token",
"documentation": "Group includes or excludes",
"xpath": "f:Group/f:characteristic/f:exclude"
},
{
"name": "identifier",
"type": "token",
"documentation": "Unique id",
"xpath": "f:Group/f:identifier"
},
{
"name": "member",
"type": "reference",
"documentation": "Who is in group",
"xpath": "f:Group/f:member"
},
{
"name": "type",
"type": "token",
"documentation": "The type of resources the group contains",
"xpath": "f:Group/f:type"
},
{
"name": "value",
"type": "token",
"documentation": "Value held by characteristic",
"xpath": "f:Group/f:characteristic/f:value[x]"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change