RequestGroup - FHIR Resource (stu3)


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

Resource Attributes

AttributeField is listTypeDescription
actiontrueData Type Proposed actions, if any
authorfalseReference Device or practitioner that authored the request group
authoredOnfalsedateTime When the request group was authored
basedOntrueReference Fulfills plan, proposal, or order
contextfalseReference Encounter or Episode for the request group
definitiontrueReference Instantiates protocol or definition
groupIdentifierfalseIdentifier Composite request this is part of
identifiertrueIdentifier Business identifier
intentfalsecode proposal | plan | order
notetrueAnnotation Additional notes about the response
priorityfalsecode routine | urgent | asap | stat
reasonCodeableConceptfalseCodeableConcept "reasonCodeableConcept" : { CodeableConcept },
reasonReferencefalseReference "reasonReference" : { Reference(Any) },
replacestrueReference Request(s) replaced by this request
statusfalsecode draft | active | suspended | cancelled | completed | entered-in-error | unknown
subjectfalseReference Who the request group is about

RequestGroup Example

{
  "status": "draft",
  "reasonCodeableConcept": {
    "text": "Treatment"
  },
  "authoredOn": "2017-03-06T17:31:00Z",
  "groupIdentifier": {
    "system": "http://example.org/treatment-group",
    "value": "00001"
  },
  "resourceType": "RequestGroup",
  "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>"
  },
  "author": {
    "reference": "Practitioner/1"
  },
  "priority": "routine",
  "contained": [
    {
      "resourceType": "MedicationRequest",
      "medicationCodeableConcept": {
        "text": "Medication 1"
      },
      "intent": "proposal",
      "id": "medicationrequest-1",
      "subject": {
        "reference": "Patient/example"
      }
    },
    {
      "resourceType": "MedicationRequest",
      "medicationCodeableConcept": {
        "text": "Medication 2"
      },
      "intent": "proposal",
      "id": "medicationrequest-2",
      "subject": {
        "reference": "Patient/example"
      }
    }
  ],
  "intent": "plan",
  "context": {
    "reference": "Encounter/example"
  },
  "action": [
    {
      "requiredBehavior": "must",
      "participant": [
        {
          "reference": "Practitioner/1"
        }
      ],
      "description": "Administer medications at the appropriate time",
      "title": "Administer Medications",
      "timingDateTime": "2017-03-06T19:00:00Z",
      "groupingBehavior": "logical-group",
      "label": "1",
      "textEquivalent": "Administer medication 1, followed an hour later by medication 2",
      "action": [
        {
          "resource": {
            "reference": "#medicationrequest-1"
          },
          "type": {
            "code": "create"
          },
          "id": "medication-action-1",
          "description": "Administer medication 1"
        },
        {
          "resource": {
            "reference": "#medicationrequest-2"
          },
          "type": {
            "code": "create"
          },
          "id": "medication-action-2",
          "relatedAction": [
            {
              "offsetDuration": {
                "unit": "h",
                "value": 1
              },
              "actionId": "medication-action-1",
              "relationship": "after-end"
            }
          ],
          "description": "Administer medication 2"
        }
      ],
      "selectionBehavior": "all",
      "precheckBehavior": "yes",
      "cardinalityBehavior": "single"
    }
  ],
  "identifier": [
    {
      "value": "requestgroup-1"
    }
  ],
  "id": "example",
  "note": [
    {
      "text": "Additional notes about the request group"
    }
  ],
  "subject": {
    "reference": "Patient/example"
  }
}

RequestGroup Structure


  
{
  "resourceType" : "RequestGroup",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "definition" : [{ Reference(Any) }], // Instantiates 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 | suspended | cancelled | completed | entered-in-error | unknown
  "intent" : "<code>", // R!  proposal | plan | order
  "priority" : "<code>", // routine | urgent | asap | stat
  "subject" : { Reference(Patient|Group) }, // Who the request group is about
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode for the request group
  "authoredOn" : "<dateTime>", // When the request group was authored
  "author" : { Reference(Device|Practitioner) }, // Device or practitioner that authored the request group
  // reason[x]: Reason for the request group. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "note" : [{ Annotation }], // Additional notes about the response
  "action" : [{ // Proposed actions, if any
    "label" : "<string>", // User-visible label 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
    "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
      "description" : "<string>", // Natural language description of the condition
      "language" : "<string>", // Language of the expression
      "expression" : "<string>" // 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 5:
    "timingDateTime" : "<dateTime>",
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "participant" : [{ Reference(Patient|Person|Practitioner|RelatedPerson) }], // Who should perform the action
    "type" : { Coding }, // 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 the like so:

https://api.1up.health/fhir/stu3/RequestGroup?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authorreferenceauthor
authoreddateauthoredOn
contextreferencecontext
definitionreferencedefinition
encounterreferencecontext
group-identifiertextgroupIdentifier
identifiertextidentifier
intenttextintent
participantreferenceaction.participant
patientreferencesubject
prioritytextpriority
statustextstatus
subjectreferencesubject