Group - FHIR Resource (stu3)


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

Validate an Group FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
activefalseboolean# Whether this group's record is in active use
actualfalseboolean# C? Descriptive or actual
characteristictrueData Type# Trait of group members
codefalseCodeableConcept# Kind of Group members
identifiertrueIdentifier# Unique id
membertrueData Type# C? Who or what is in group
namefalsestring# Label for Group
quantityfalseunsignedInt# Number of members
typefalsecode# person | animal | practitioner | device | medication | substance

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 the like so:

https://api.1up.health/fhir/stu3/Group?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
actualtextactual
characteristictextcharacteristic.code
characteristic-valuecompositecharacteristic
codetextcode
excludetextcharacteristic.exclude
identifiertextidentifier
memberreferencemember.entity
typetexttype
valuetextcharacteristic.value