RequestGroup
A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/RequestGroup/[id] |
| Vread | GET | /fhir/R4/RequestGroup/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/RequestGroup/[id] |
| Patch | PATCH | /fhir/R4/RequestGroup/[id] |
| Delete | DELETE | /fhir/R4/RequestGroup/[id] |
| Create | POST | /fhir/R4/RequestGroup |
| Search | GET | /fhir/R4/RequestGroup |
| History | GET | /fhir/R4/RequestGroup/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Business identifier |
instantiatesCanonical | canonical | 0..* | Instantiates FHIR protocol or definition |
instantiatesUri | uri | 0..* | Instantiates external protocol or definition |
basedOn | Reference | 0..* | Fulfills plan, proposal, or order |
replaces | Reference | 0..* | Request(s) replaced by this request |
groupIdentifier | Identifier | 0..1 | Composite request this is part of |
status | code | 1..1 | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | code | 1..1 | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
priority | code | 0..1 | routine | urgent | asap | stat |
code | CodeableConcept | 0..1 | What's being requested/ordered |
subject | Reference | 0..1 | Who the request group is about |
encounter | Reference | 0..1 | Created as part of |
authoredOn | dateTime | 0..1 | When the request group was authored |
author | Reference | 0..1 | Device or practitioner that authored the request group |
reasonCode | CodeableConcept | 0..* | Why the request group is needed |
reasonReference | Reference | 0..* | Why the request group is needed |
note | Annotation | 0..* | Additional notes about the response |
action | BackboneElement | 0..* | Proposed actions, if any |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
author | reference | The author of the request group |
authored | date | The date the request group was authored |
code | token | The code of the request group |
encounter | reference | The encounter the request group applies to |
group-identifier | token | The group identifier for the request group |
identifier | token | External identifiers for the request group |
instantiates-canonical | reference | The FHIR-based definition from which the request group is realized |
instantiates-uri | uri | The external definition from which the request group is realized |
intent | token | The intent of the request group |
participant | reference | The participant in the requests in the group |
patient | reference | The identity of a patient to search for request groups |
priority | token | The priority of the request group |
status | token | The status of the request group |
subject | reference | The subject that the request group is about |
Reference
Official FHIR R4 spec: RequestGroup.
Maturity: Trial Use 2 (FMM 2).