Group - FHIR Resource (dstu2)
This Group Resource uses the FHIR API standard for access and structure.
Validate an Group FHIR Resource (dstu2)
Group Attributes
AttributeField is listTypeDescription
Description: Kind of Group members
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": Learn more about the (Group) code FHIR attribute
Description: C? Descriptive or actual
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"actual": Learn more about the (Group) actual FHIR attribute
Description: Label for Group
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (Group) name FHIR attribute
Description: Trait of group members
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"characteristic": Learn more about the (Group) characteristic FHIR attribute
Description: C? Who or what is in group
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"member": Learn more about the (Group) member FHIR attribute
Description: Unique id
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Group) identifier FHIR attribute
Description: person | animal | practitioner | device | medication | substance
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Group) type FHIR attribute
Description: Number of members
FHIR Version: dstu2
Attribute Type : unsignedInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"quantity": Learn more about the (Group) quantity FHIR attribute
Group Structure
{
"resourceType" : "Group",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Unique id
"type" : "<code>", // R! person | animal | practitioner | device | medication | substance
"actual" : <boolean>, // C? R! Descriptive or actual
"code" : { CodeableConcept }, // Kind of Group members
"name" : "<string>", // Label for Group
"quantity" : "<unsignedInt>", // Number of members
"characteristic" : [{ // Trait of group members
"code" : { CodeableConcept }, // R! Kind of characteristic
// value[x]: Value held by characteristic. One of these 4:
"valueCodeableConcept" : { CodeableConcept },
"valueBoolean" : <boolean>,
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"exclude" : <boolean>, // R! Group includes or excludes
"period" : { Period } // Period over which characteristic is tested
}],
"member" : [{ // C? Who or what is in group
"entity" : { Reference(Patient|Practitioner|Device|Medication|Substance) }, // R! Reference to the group member
"period" : { Period }, // Period member belonged to the group
"inactive" : <boolean> // If member is no longer in group
}]
}
Group Search Parameters
The following search parameters can be used to query Group resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/Group?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
actual | text | actual |
characteristic | text | characteristic.code |
characteristic-value | composite | |
code | text | code |
exclude | text | characteristic.exclude |
identifier | text | identifier |
member | reference | member.entity |
type | text | type |
value | text | characteristic.value[x] |
