The FHIR STU3 RequestGroup resource represents a group of related requests that can be used to capture intended activities that have inter-dependencies. In Health Gorilla this resource used to describe a laboratory/radiology order.

FHIR Resource: RequestGroup <https://www.hl7.org/fhir/requestgroup.html>

Required Profile

https://healthgorilla.com/fhir/StructureDefinition/hg-order

Supported Attributes

Name	Comment
identifier	ACSN (Lab Reference ID), HG ID
requisition
status
intent
subject	Patient
priority
author	Practitioner
authoredOn
action	ProcedureRequest
note
`<https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-authorizedBy>`	Author(Organization)
`<https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-account>`	Account
`<https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-performer>`	Performer(Organization)
`<https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-requester>`	Requester
`<https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-reasoncode>`	Diagnoses
`<https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-specimen>`	Specimen
`<https://www.healthgorilla.com/fhir/StructureDefinition/requestgroup-deliveryOptions>`	Delivery Options (location, method, electronic)
`<https://www.healthgorilla.com/fhir/StructureDefinition/performer-location>`	Performer Location (Location)

https://api.healthgorilla.com/fhir/RequestGroup

FHIR Operations

The following operations are currently supported:

1. Read

HTTP Request	Method	Action
/RequestGroup/`{ID}`	GET	Retrieve RequestGroup resource by ID

2. Search

HTTP Request	Method	Action
/RequestGroup?[parameter=`{value}`]	GET	Retrieve RequestGroup resources by the specified search criteria

Parameters:

Key	Type	Description
patient	Reference	Patient Identifier
identifier	Token	External Identifier
_lastUpdated	Date
_offset	Number
_count	Number

Examples

2.1 Retrieve Order by ID

https://api.healthgorilla.com/fhir/RequestGroup/a5606c5b8998949c08f49526

2.2 Retrieve Order by requisition ID

https://api.healthgorilla.com/fhir/RequestGroup?identifier=https://www.healthgorilla.com| a5606c5b8998949c08f49526

2.3 Retrieve Orders by Lab Reference ID

https://api.healthgorilla.com/fhir/RequestGroup?performer={{facility_id}}&identifier={{lab_reference_id}}

2.4 Retrieve Orders by patient and date

https://api.healthgorilla.com/fhir/RequestGroup?patient=8063965523692105bfc35def&_lastUpdated=2018-07

3. Create

Clients can submit new orders. Visit Diagnostic Network Guide for more details

4. Download PDF

You can generate a PDF copy of the record using the following request:

HTTP Request	Method	Action
/RequestGroup/`{ID}`/$pdf	GET	Generate PDF

The result contains a link to a Binary resource (PDF) that can be downloaded.

Example

https://api.healthgorilla.com/fhir/RequestGroup/8063965523692105bfc35def/$pdf

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "url",
            "valueString": "http://api.healthgorilla.com/fhir/Binary/bf5e745ba2f573534d447686"
        },
        {
            "name": "contentType",
            "valueString": "application/pdf"
        },
        {
            "name": "size",
            "valuePositiveInt": 13081
        }
    ]
}

5. Print Labels

You can generate a PDF copy of the labels associated with an order using the following request:

HTTP Request	Method	Action
/RequestGroup/`{ID}`/$label	GET	Generate Labels

The result contains a link to a Binary resource (PDF) that can be downloaded.

Example

https://api.healthgorilla.com/fhir/R4/RequestGroup/8063965523692105bfc35def/$labels

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "url",
            "valueString": "http://api.healthgorilla.com/fhir/Binary/bf5e745ba2f573534d447686"
        },
        {
            "name": "contentType",
            "valueString": "application/pdf"
        },
        {
            "name": "size",
            "valuePositiveInt": 13081
        }
    ]
}