Group - FHIR Resource (stu3)

This Group Resource uses the FHIR API standard for access and structure.

Validate an Group FHIR Resource (stu3)

Group Attributes

AttributeField is listTypeDescription

Description: Kind of Group members

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code": {
  "text": "Horse"
}

Learn more about the (Group) code FHIR attribute

Description: C? Descriptive or actual

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"actual": true

Learn more about the (Group) actual FHIR attribute

Description: Label for Group

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "John's herd"

Learn more about the (Group) name FHIR attribute

Description: Trait of group members

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"characteristic": [
  {
    "valueCodeableConcept": {
      "text": "mixed"
    },
    "exclude": false,
    "code": {
      "text": "gender"
    }
  },
  {
    "valueCodeableConcept": {
      "text": "John Smith"
    },
    "exclude": false,
    "code": {
      "text": "owner"
    }
  }
]

Learn more about the (Group) characteristic FHIR attribute

Description: C? Who or what is in group

FHIR Version: stu3

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: Whether this group's record is in active use

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"active":

Learn more about the (Group) active FHIR attribute

Description: Unique id

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://someveterinarianclinic.org/fhir/NamingSystem/herds",
    "value": "12345"
  }
]

Learn more about the (Group) identifier FHIR attribute

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"type": "animal"

Learn more about the (Group) type FHIR attribute

Description: Number of members

FHIR Version: stu3

Attribute Type : unsignedInt

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"quantity": 25

Learn more about the (Group) quantity FHIR attribute

Group Example

{
  "code": {
    "text": "Horse"
  },
  "actual": true,
  "name": "John's herd",
  "resourceType": "Group",
  "text": {
    "status": "additional",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>Herd of 25 horses</p>\n      <p>Gender: mixed</p>\n      <p>Owner: John Smith</p>\n    </div>"
  },
  "characteristic": [
    {
      "valueCodeableConcept": {
        "text": "mixed"
      },
      "exclude": false,
      "code": {
        "text": "gender"
      }
    },
    {
      "valueCodeableConcept": {
        "text": "John Smith"
      },
      "exclude": false,
      "code": {
        "text": "owner"
      }
    }
  ],
  "identifier": [
    {
      "system": "http://someveterinarianclinic.org/fhir/NamingSystem/herds",
      "value": "12345"
    }
  ],
  "type": "animal",
  "id": "101",
  "quantity": 25
}

Group Structure


  
{
  "resourceType" : "Group",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique id
  "active" : <boolean>, // Whether this group's record is in active use
  "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/stu3/Group?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`actual`	`text`	`actual`
`characteristic`	`text`	`characteristic.code`
`characteristic-value`	`composite`	`characteristic`
`code`	`text`	`code`
`exclude`	`text`	`characteristic.exclude`
`identifier`	`text`	`identifier`
`member`	`reference`	`member.entity`
`type`	`text`	`type`
`value`	`text`	`characteristic.value`