request groups

Create Request Group

post
/organizations/{organizationId}/fhir/3/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".

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringRequestGroupThis is a RequestGroup resource
identifierarray(Identifier)Allows a service to provide a unique, business identifier for the request.
definitionarray(Reference)A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this request.
replacesarray(Reference)Completed or terminated request(s) whose function is taken by this new request.
groupIdentifierIdentifierA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
statusstringThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentstringIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
prioritystringIndicates how quickly the request should be addressed with respect to other requests.
subjectReferenceThe subject for which the request group was created.
contextReferenceDescribes the context of the request group, if any.
authoredOnstringIndicates when the request group was created.
authorReferenceProvides a reference to the author of the request group.
reasonCodeableConceptCodeableConceptIndicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
reasonReferenceReferenceIndicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
notearray(Annotation)Provides a mechanism to communicate additional information about the response.
actionarray(RequestGroup_Action)The actions, if any, produced by the evaluation of the artifact.

Response

Patch Request Group

patch
/organizations/{organizationId}/fhir/3/RequestGroup/{resourceId}

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".

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringRequestGroupThis is a RequestGroup resource
identifierarray(Identifier)Allows a service to provide a unique, business identifier for the request.
definitionarray(Reference)A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this request.
replacesarray(Reference)Completed or terminated request(s) whose function is taken by this new request.
groupIdentifierIdentifierA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
statusstringThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentstringIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
prioritystringIndicates how quickly the request should be addressed with respect to other requests.
subjectReferenceThe subject for which the request group was created.
contextReferenceDescribes the context of the request group, if any.
authoredOnstringIndicates when the request group was created.
authorReferenceProvides a reference to the author of the request group.
reasonCodeableConceptCodeableConceptIndicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
reasonReferenceReferenceIndicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
notearray(Annotation)Provides a mechanism to communicate additional information about the response.
actionarray(RequestGroup_Action)The actions, if any, produced by the evaluation of the artifact.

Response

Read Request Group

get
/organizations/{organizationId}/fhir/3/RequestGroup/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Request Group

get
/organizations/{organizationId}/fhir/3/RequestGroup/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Request Group

get
/organizations/{organizationId}/fhir/3/RequestGroup/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Request Group

delete
/organizations/{organizationId}/fhir/3/RequestGroup/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Request Group

get
/organizations/{organizationId}/fhir/3/RequestGroup

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
authoredstring
contextstring
definitionstring
encounterstring
group-identifierstring
identifierstring
intentstring
participantstring
patientstring
prioritystring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Request Group

get
/organizations/{organizationId}/fhir/3/RequestGroup/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Request Group

post
/organizations/{organizationId}/fhir/3/RequestGroup/_search

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".

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
authoredstring
contextstring
definitionstring
encounterstring
group-identifierstring
identifierstring
intentstring
participantstring
patientstring
prioritystring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringRequestGroupThis is a RequestGroup resource
identifierarray(Identifier)Allows a service to provide a unique, business identifier for the request.
definitionarray(Reference)A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this request.
replacesarray(Reference)Completed or terminated request(s) whose function is taken by this new request.
groupIdentifierIdentifierA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
statusstringThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentstringIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
prioritystringIndicates how quickly the request should be addressed with respect to other requests.
subjectReferenceThe subject for which the request group was created.
contextReferenceDescribes the context of the request group, if any.
authoredOnstringIndicates when the request group was created.
authorReferenceProvides a reference to the author of the request group.
reasonCodeableConceptCodeableConceptIndicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
reasonReferenceReferenceIndicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
notearray(Annotation)Provides a mechanism to communicate additional information about the response.
actionarray(RequestGroup_Action)The actions, if any, produced by the evaluation of the artifact.

Response

Update Request Group

put
/organizations/{organizationId}/fhir/3/RequestGroup/{resourceId}

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".

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringRequestGroupThis is a RequestGroup resource
identifierarray(Identifier)Allows a service to provide a unique, business identifier for the request.
definitionarray(Reference)A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this request.
replacesarray(Reference)Completed or terminated request(s) whose function is taken by this new request.
groupIdentifierIdentifierA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
statusstringThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentstringIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
prioritystringIndicates how quickly the request should be addressed with respect to other requests.
subjectReferenceThe subject for which the request group was created.
contextReferenceDescribes the context of the request group, if any.
authoredOnstringIndicates when the request group was created.
authorReferenceProvides a reference to the author of the request group.
reasonCodeableConceptCodeableConceptIndicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
reasonReferenceReferenceIndicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
notearray(Annotation)Provides a mechanism to communicate additional information about the response.
actionarray(RequestGroup_Action)The actions, if any, produced by the evaluation of the artifact.

Response