Group
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.
Columns
Header row
# |
path |
type |
required |
description |
0 |
resourceType |
string |
* |
Resource type identifier. Must be string "Group" |
1 |
|
integer |
* |
Number of subrows |
2 |
id |
string |
* |
Logical id of this artifact |
3 |
active |
boolean |
|
Whether this group's record is in active use |
4 |
type |
code |
|
person | animal | practitioner | device | medication | substance |
5 |
actual |
boolean |
|
Descriptive or actual |
|
code |
CodeableConcept |
|
Kind of Group members |
|
code.coding |
Coding |
|
Code defined by a terminology system |
6 |
code.coding.system |
uri |
|
Identity of the terminology system |
7 |
code.coding.version |
string |
|
Version of the system - if relevant |
8 |
code.coding.code |
code |
|
Symbol in syntax defined by the system |
9 |
code.coding.display |
string |
|
Representation defined by the system |
10 |
code.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
11 |
code.text |
string |
|
Plain text representation of the concept |
12 |
name |
string |
|
Label for Group |
13 |
quantity |
unsignedInt |
|
Number of members |
|
managingEntity |
Reference |
|
Entity that is the custodian of the Group's definition |
14 |
managingEntity.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
15 |
managingEntity.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
managingEntity.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
16 |
managingEntity.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
managingEntity.identifier.type |
CodeableConcept |
|
Description of identifier |
|
managingEntity.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
17 |
managingEntity.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
18 |
managingEntity.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
19 |
managingEntity.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
20 |
managingEntity.identifier.type.coding.display |
string |
|
Representation defined by the system |
21 |
managingEntity.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
22 |
managingEntity.identifier.type.text |
string |
|
Plain text representation of the concept |
23 |
managingEntity.identifier.system |
uri |
|
The namespace for the identifier value |
24 |
managingEntity.identifier.value |
string |
|
The value that is unique |
|
managingEntity.identifier.period |
Period |
|
Time period when id is/was valid for use |
25 |
managingEntity.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
26 |
managingEntity.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
27 |
managingEntity.display |
string |
|
Text alternative for the resource |
Row identifier
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "identifier" |
|
identifier |
Identifier |
|
Unique id |
1 |
identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
identifier.type |
CodeableConcept |
|
Description of identifier |
|
identifier.type.coding |
Coding |
|
Code defined by a terminology system |
2 |
identifier.type.coding.system |
uri |
|
Identity of the terminology system |
3 |
identifier.type.coding.version |
string |
|
Version of the system - if relevant |
4 |
identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
5 |
identifier.type.coding.display |
string |
|
Representation defined by the system |
6 |
identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
7 |
identifier.type.text |
string |
|
Plain text representation of the concept |
8 |
identifier.system |
uri |
|
The namespace for the identifier value |
9 |
identifier.value |
string |
|
The value that is unique |
|
identifier.period |
Period |
|
Time period when id is/was valid for use |
10 |
identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
11 |
identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row characteristic
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "characteristic" |
|
characteristic |
|
|
Include / Exclude group members by Trait |
|
characteristic.code |
CodeableConcept |
|
Kind of characteristic |
|
characteristic.code.coding |
Coding |
|
Code defined by a terminology system |
1 |
characteristic.code.coding.system |
uri |
|
Identity of the terminology system |
2 |
characteristic.code.coding.version |
string |
|
Version of the system - if relevant |
3 |
characteristic.code.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
characteristic.code.coding.display |
string |
|
Representation defined by the system |
5 |
characteristic.code.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
characteristic.code.text |
string |
|
Plain text representation of the concept |
|
characteristic.value[x] |
|
|
Value held by characteristic |
|
characteristic.valueCodeableConcept |
CodeableConcept |
|
|
|
characteristic.valueCodeableConcept.coding |
Coding |
|
Code defined by a terminology system |
7 |
characteristic.valueCodeableConcept.coding.system |
uri |
|
Identity of the terminology system |
8 |
characteristic.valueCodeableConcept.coding.version |
string |
|
Version of the system - if relevant |
9 |
characteristic.valueCodeableConcept.coding.code |
code |
|
Symbol in syntax defined by the system |
10 |
characteristic.valueCodeableConcept.coding.display |
string |
|
Representation defined by the system |
11 |
characteristic.valueCodeableConcept.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
12 |
characteristic.valueCodeableConcept.text |
string |
|
Plain text representation of the concept |
13 |
characteristic.valueBoolean |
boolean |
|
|
|
characteristic.valueQuantity |
Quantity |
|
|
14 |
characteristic.valueQuantity.value |
decimal |
|
Numerical value (with implicit precision) |
15 |
characteristic.valueQuantity.comparator |
code |
|
< | <= | >= | > - how to understand the value |
16 |
characteristic.valueQuantity.unit |
string |
|
Unit representation |
17 |
characteristic.valueQuantity.system |
uri |
|
System that defines coded unit form |
18 |
characteristic.valueQuantity.code |
code |
|
Coded form of the unit |
|
characteristic.valueRange |
Range |
|
|
|
characteristic.valueRange.low |
Quantity |
|
Low limit |
19 |
characteristic.valueRange.low.value |
decimal |
|
Numerical value (with implicit precision) |
20 |
characteristic.valueRange.low.unit |
string |
|
Unit representation |
21 |
characteristic.valueRange.low.system |
uri |
|
System that defines coded unit form |
22 |
characteristic.valueRange.low.code |
code |
|
Coded form of the unit |
|
characteristic.valueRange.high |
Quantity |
|
High limit |
23 |
characteristic.valueRange.high.value |
decimal |
|
Numerical value (with implicit precision) |
24 |
characteristic.valueRange.high.unit |
string |
|
Unit representation |
25 |
characteristic.valueRange.high.system |
uri |
|
System that defines coded unit form |
26 |
characteristic.valueRange.high.code |
code |
|
Coded form of the unit |
|
characteristic.valueReference |
Reference |
|
|
27 |
characteristic.valueReference.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
28 |
characteristic.valueReference.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
characteristic.valueReference.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
29 |
characteristic.valueReference.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
characteristic.valueReference.identifier.type |
CodeableConcept |
|
Description of identifier |
|
characteristic.valueReference.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
30 |
characteristic.valueReference.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
31 |
characteristic.valueReference.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
32 |
characteristic.valueReference.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
33 |
characteristic.valueReference.identifier.type.coding.display |
string |
|
Representation defined by the system |
34 |
characteristic.valueReference.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
35 |
characteristic.valueReference.identifier.type.text |
string |
|
Plain text representation of the concept |
36 |
characteristic.valueReference.identifier.system |
uri |
|
The namespace for the identifier value |
37 |
characteristic.valueReference.identifier.value |
string |
|
The value that is unique |
|
characteristic.valueReference.identifier.period |
Period |
|
Time period when id is/was valid for use |
38 |
characteristic.valueReference.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
39 |
characteristic.valueReference.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
40 |
characteristic.valueReference.display |
string |
|
Text alternative for the resource |
41 |
characteristic.exclude |
boolean |
|
Group includes or excludes |
|
characteristic.period |
Period |
|
Period over which characteristic is tested |
42 |
characteristic.period.start |
dateTime |
|
Starting time with inclusive boundary |
43 |
characteristic.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row member
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "member" |
|
member |
|
|
Who or what is in group |
|
member.entity |
Reference |
|
Reference to the group member |
1 |
member.entity.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
member.entity.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
member.entity.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
member.entity.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
member.entity.identifier.type |
CodeableConcept |
|
Description of identifier |
|
member.entity.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
member.entity.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
member.entity.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
member.entity.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
member.entity.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
member.entity.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
member.entity.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
member.entity.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
member.entity.identifier.value |
string |
|
The value that is unique |
|
member.entity.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
member.entity.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
member.entity.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
member.entity.display |
string |
|
Text alternative for the resource |
|
member.period |
Period |
|
Period member belonged to the group |
15 |
member.period.start |
dateTime |
|
Starting time with inclusive boundary |
16 |
member.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
17 |
member.inactive |
boolean |
|
If member is no longer in group |
Examples
Example #1
Input CSV
Group,2,"herd1",true,"animal",true,"http://snomed.info/sct",,"388393002","Genus Sus (organism)",,"Porcine","Breeding herd",2500,,,,,,,,,,,,,,
identifier,,,,,,,,"https://vetmed.iastate.edu/vdl","20171120-1234",,
characteristic,,,,,,"gender",,,,,,"female",,,,,,,,,,,,,,,,,,,,,,,,,,,,,false,,
Resulting resource
{
"resourceType": "Group",
"id": "herd1",
"identifier": [
{
"system": "https://vetmed.iastate.edu/vdl",
"value": "20171120-1234"
}
],
"active": true,
"type": "animal",
"actual": true,
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "388393002",
"display": "Genus Sus (organism)"
},
{
"system": "https://www.aphis.usda.gov",
"code": "POR",
"display": "porcine"
}
],
"text": "Porcine"
},
"name": "Breeding herd",
"quantity": 2500,
"characteristic": [
{
"code": {
"text": "gender"
},
"valueCodeableConcept": {
"text": "female"
},
"exclude": false
}
]
}
Example #2
Input CSV
Group,3,"101",,"animal",true,,,,,,"Horse","John's herd",25,,,,,,,,,,,,,,
identifier,,,,,,,,"http://someveterinarianclinic.org/fhir/NamingSystem/herds","12345",,
characteristic,,,,,,"gender",,,,,,"mixed",,,,,,,,,,,,,,,,,,,,,,,,,,,,,false,,
characteristic,,,,,,"owner",,,,,,"John Smith",,,,,,,,,,,,,,,,,,,,,,,,,,,,,false,,
Resulting resource
{
"resourceType": "Group",
"id": "101",
"identifier": [
{
"system": "http://someveterinarianclinic.org/fhir/NamingSystem/herds",
"value": "12345"
}
],
"type": "animal",
"actual": true,
"code": {
"text": "Horse"
},
"name": "John's herd",
"quantity": 25,
"characteristic": [
{
"code": {
"text": "gender"
},
"valueCodeableConcept": {
"text": "mixed"
},
"exclude": false
},
{
"code": {
"text": "owner"
},
"valueCodeableConcept": {
"text": "John Smith"
},
"exclude": false
}
]
}
Example #3
Input CSV
Group,4,"102",,"person",true,,,,,,,,,,,,,,,,,,,,,,
member,"Patient/pat1",,,,,,,,,,,,,,"2014-10-08",,
member,"Patient/pat2",,,,,,,,,,,,,,"2015-04-02",,true
member,"Patient/pat3",,,,,,,,,,,,,,"2015-08-06",,
member,"Patient/pat4",,,,,,,,,,,,,,"2015-08-06",,
Resulting resource
{
"resourceType": "Group",
"id": "102",
"type": "person",
"actual": true,
"member": [
{
"entity": {
"reference": "Patient/pat1"
},
"period": {
"start": "2014-10-08"
}
},
{
"entity": {
"reference": "Patient/pat2"
},
"period": {
"start": "2015-04-02"
},
"inactive": true
},
{
"entity": {
"reference": "Patient/pat3"
},
"period": {
"start": "2015-08-06"
}
},
{
"entity": {
"reference": "Patient/pat4"
},
"period": {
"start": "2015-08-06"
}
}
]
}
Example #4
Input CSV
Group,1,"example-patientlist",,"person",true,,,,,,,,,,,,,,,,,,,,,,
characteristic,"http://example.org",,"attributed-to",,,"Patients primarily attributed to",,,,,,,,,,,,,,,,,,,,,"Practitioner/123",,,,,,,,,,,,,,false,,
Resulting resource
{
"resourceType": "Group",
"id": "example-patientlist",
"type": "person",
"actual": true,
"characteristic": [
{
"code": {
"coding": [
{
"system": "http://example.org",
"code": "attributed-to"
}
],
"text": "Patients primarily attributed to"
},
"valueReference": {
"reference": "Practitioner/123"
},
"exclude": false
}
]
}