RequestGroup - FHIR Resource (r4)

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

Validate an RequestGroup FHIR Resource (r4)

RequestGroup Attributes

AttributeField is listTypeDescription

Description: Business identifier

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "value": "requestgroup-1"
  }
]

Learn more about the (RequestGroup) identifier FHIR attribute

Description: Instantiates FHIR protocol or definition

FHIR Version: r4

Attribute Type : canonical

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"instantiatesCanonical":

Learn more about the (RequestGroup) instantiatesCanonical FHIR attribute

Description: Instantiates external protocol or definition

FHIR Version: r4

Attribute Type : uri

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"instantiatesUri":

Learn more about the (RequestGroup) instantiatesUri FHIR attribute

Description: Fulfills plan, proposal, or order

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"basedOn":

Learn more about the (RequestGroup) basedOn FHIR attribute

Description: Request(s) replaced by this request

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"replaces":

Learn more about the (RequestGroup) replaces FHIR attribute

Description: Composite request this is part of

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"groupIdentifier": {
  "system": "http://example.org/treatment-group",
  "value": "00001"
}

Learn more about the (RequestGroup) groupIdentifier FHIR attribute

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (RequestGroup) status FHIR attribute

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"intent": "plan"

Learn more about the (RequestGroup) intent FHIR attribute

Description: routine | urgent | asap | stat

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"priority": "routine"

Learn more about the (RequestGroup) priority FHIR attribute

Description: What's being requested/ordered

FHIR Version: r4

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 (RequestGroup) code FHIR attribute

Description: Who the request group is about

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subject": {
  "reference": "Patient/example"
}

Learn more about the (RequestGroup) subject FHIR attribute

Description: Created as part of

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"encounter": {
  "reference": "Encounter/example"
}

Learn more about the (RequestGroup) encounter FHIR attribute

Description: When the request group was authored

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"authoredOn": "2017-03-06T17:31:00Z"

Learn more about the (RequestGroup) authoredOn FHIR attribute

Description: Device or practitioner that authored the request group

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"author": {
  "reference": "Practitioner/1"
}

Learn more about the (RequestGroup) author FHIR attribute

Description: Why the request group is needed

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reasonCode": [
  {
    "text": "Treatment"
  }
]

Learn more about the (RequestGroup) reasonCode FHIR attribute

Description: "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reasonReference":

Learn more about the (RequestGroup) reasonReference FHIR attribute

Description: Additional notes about the response

FHIR Version: r4

Attribute Type : Annotation

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"note": [
  {
    "text": "Additional notes about the request group"
  }
]

Learn more about the (RequestGroup) note FHIR attribute

Description: Proposed actions, if any

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"action": [
  {
    "prefix": "1",
    "title": "Administer Medications",
    "description": "Administer medications at the appropriate time",
    "textEquivalent": "Administer medication 1, followed an hour later by medication 2",
    "timingDateTime": "2017-03-06T19:00:00Z",
    "participant": [
      {
        "reference": "Practitioner/1"
      }
    ],
    "groupingBehavior": "logical-group",
    "selectionBehavior": "all",
    "requiredBehavior": "must",
    "precheckBehavior": "yes",
    "cardinalityBehavior": "single",
    "action": [
      {
        "id": "medication-action-1",
        "description": "Administer medication 1",
        "type": {
          "coding": [
            {
              "code": "create"
            }
          ]
        },
        "resource": {
          "reference": "#medicationrequest-1"
        }
      },
      {
        "id": "medication-action-2",
        "description": "Administer medication 2",
        "relatedAction": [
          {
            "actionId": "medication-action-1",
            "relationship": "after-end",
            "offsetDuration": {
              "value": 1,
              "unit": "h"
            }
          }
        ],
        "type": {
          "coding": [
            {
              "code": "create"
            }
          ]
        },
        "resource": {
          "reference": "#medicationrequest-2"
        }
      }
    ]
  }
]

Learn more about the (RequestGroup) action FHIR attribute

RequestGroup Example

{
  "resourceType": "RequestGroup",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Example RequestGroup illustrating related actions to administer medications in sequence with time delay.</div>"
  },
  "contained": [
    {
      "resourceType": "MedicationRequest",
      "id": "medicationrequest-1",
      "status": "unknown",
      "intent": "proposal",
      "medicationCodeableConcept": {
        "text": "Medication 1"
      },
      "subject": {
        "reference": "Patient/example"
      }
    },
    {
      "resourceType": "MedicationRequest",
      "id": "medicationrequest-2",
      "status": "unknown",
      "intent": "proposal",
      "medicationCodeableConcept": {
        "text": "Medication 2"
      },
      "subject": {
        "reference": "Patient/example"
      }
    }
  ],
  "identifier": [
    {
      "value": "requestgroup-1"
    }
  ],
  "groupIdentifier": {
    "system": "http://example.org/treatment-group",
    "value": "00001"
  },
  "status": "draft",
  "intent": "plan",
  "priority": "routine",
  "subject": {
    "reference": "Patient/example"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "authoredOn": "2017-03-06T17:31:00Z",
  "author": {
    "reference": "Practitioner/1"
  },
  "reasonCode": [
    {
      "text": "Treatment"
    }
  ],
  "note": [
    {
      "text": "Additional notes about the request group"
    }
  ],
  "action": [
    {
      "prefix": "1",
      "title": "Administer Medications",
      "description": "Administer medications at the appropriate time",
      "textEquivalent": "Administer medication 1, followed an hour later by medication 2",
      "timingDateTime": "2017-03-06T19:00:00Z",
      "participant": [
        {
          "reference": "Practitioner/1"
        }
      ],
      "groupingBehavior": "logical-group",
      "selectionBehavior": "all",
      "requiredBehavior": "must",
      "precheckBehavior": "yes",
      "cardinalityBehavior": "single",
      "action": [
        {
          "id": "medication-action-1",
          "description": "Administer medication 1",
          "type": {
            "coding": [
              {
                "code": "create"
              }
            ]
          },
          "resource": {
            "reference": "#medicationrequest-1"
          }
        },
        {
          "id": "medication-action-2",
          "description": "Administer medication 2",
          "relatedAction": [
            {
              "actionId": "medication-action-1",
              "relationship": "after-end",
              "offsetDuration": {
                "value": 1,
                "unit": "h"
              }
            }
          ],
          "type": {
            "coding": [
              {
                "code": "create"
              }
            ]
          },
          "resource": {
            "reference": "#medicationrequest-2"
          }
        }
      ]
    }
  ]
}

RequestGroup Structure

{
  "resourceType" : "RequestGroup",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "instantiatesCanonical" : ["<canonical>"], // Instantiates FHIR protocol or definition
  "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
  "basedOn" : [{ Reference(Any) }], // Fulfills plan, proposal, or order
  "replaces" : [{ Reference(Any) }], // Request(s) replaced by this request
  "groupIdentifier" : { Identifier }, // Composite request this is part of
  "status" : "<code>", // R!  draft | active | on-hold | revoked | completed | entered-in-error | unknown
  "intent" : "<code>", // R!  proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "code" : { CodeableConcept }, // What's being requested/ordered
  "subject" : { Reference(Patient|Group) }, // Who the request group is about
  "encounter" : { Reference(Encounter) }, // Created as part of
  "authoredOn" : "<dateTime>", // When the request group was authored
  "author" : { Reference(Device|Practitioner|PractitionerRole) }, // Device or practitioner that authored the request group
  "reasonCode" : [{ CodeableConcept }], // Why the request group is needed
  "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) }], // Why the request group is needed
  "note" : [{ Annotation }], // Additional notes about the response
  "action" : [{ // Proposed actions, if any
    "prefix" : "<string>", // User-visible prefix for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Short description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or sub-actions
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "expression" : { Expression } // Boolean-valued expression
    }],
    "relatedAction" : [{ // Relationship to another action
      "actionId" : "<id>", // R!  What action this is related to
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration }
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 6:
    "timingDateTime" : "<dateTime>",
    "timingAge" : { Age },
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participant" : [{ Reference(Patient|Practitioner|PractitionerRole|
    RelatedPerson|Device) }], // Who should perform the action
    "type" : { CodeableConcept }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    "resource" : { Reference(Any) }, // C? The target of the action
    "action" : [{ Content as for RequestGroup.action }] // C? Sub action
  }]
}

RequestGroup Search Parameters

The following search parameters can be used to query RequestGroup resources. Just submit them like so:

https://api.1up.health/fhir/r4/RequestGroup?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`author`	`reference`	`author`
`authored`	`date`	`authoredOn`
`code`	`text`	`code`
`encounter`	`reference`	`encounter`
`group-identifier`	`text`	`groupIdentifier`
`identifier`	`text`	`identifier`
`instantiates-canonical`	`reference`	`instantiatesCanonical`
`instantiates-uri`	`uri`	`instantiatesUri`
`intent`	`text`	`intent`
`participant`	`reference`	`action.participant`
`patient`	`reference`	`subject.where`
`priority`	`text`	`priority`
`status`	`text`	`status`
`subject`	`reference`	`subject`