request groups
Create Request Group
post
/organizations/{organizationId}/fhir/4/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* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a RequestGroup resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Allows a service to provide a unique, business identifier for the request. | |
instantiatesCanonical | array(canonical) | A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
instantiatesUri | array(uri) | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this request. | |
replaces | array(Reference) | Completed or terminated request(s) whose function is taken by this new request. | |
groupIdentifier | Identifier | A 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. | |
status | code | The current state of the request. For request groups, the status reflects the status of all the requests in the group. | |
intent | code | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | |
priority | code | Indicates how quickly the request should be addressed with respect to other requests. | |
code | CodeableConcept | A code that identifies what the overall request group is. | |
subject | Reference | The subject for which the request group was created. | |
encounter | Reference | Describes the context of the request group, if any. | |
authoredOn | dateTime | Indicates when the request group was created. | |
author | Reference | Provides a reference to the author of the request group. | |
reasonCode | array(CodeableConcept) | Describes the reason for the request group in coded or textual form. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this request group. | |
note | array(Annotation) | Provides a mechanism to communicate additional information about the response. | |
action | array(RequestGroup_Action) | The actions, if any, produced by the evaluation of the artifact. |
Response
keyboard_arrow_down
Patch Request Group
patch
/organizations/{organizationId}/fhir/4/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* | string | application/json-patch+json | application/json-patch+json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | This is a RequestGroup resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Allows a service to provide a unique, business identifier for the request. | |
instantiatesCanonical | array(canonical) | A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
instantiatesUri | array(uri) | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this request. | |
replaces | array(Reference) | Completed or terminated request(s) whose function is taken by this new request. | |
groupIdentifier | Identifier | A 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. | |
status | code | The current state of the request. For request groups, the status reflects the status of all the requests in the group. | |
intent | code | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | |
priority | code | Indicates how quickly the request should be addressed with respect to other requests. | |
code | CodeableConcept | A code that identifies what the overall request group is. | |
subject | Reference | The subject for which the request group was created. | |
encounter | Reference | Describes the context of the request group, if any. | |
authoredOn | dateTime | Indicates when the request group was created. | |
author | Reference | Provides a reference to the author of the request group. | |
reasonCode | array(CodeableConcept) | Describes the reason for the request group in coded or textual form. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this request group. | |
note | array(Annotation) | Provides a mechanism to communicate additional information about the response. | |
action | array(RequestGroup_Action) | The actions, if any, produced by the evaluation of the artifact. |
Response
keyboard_arrow_down
Read Request Group
get
/organizations/{organizationId}/fhir/4/RequestGroup/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read History Request Group
get
/organizations/{organizationId}/fhir/4/RequestGroup/{resourceId}/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read Version Request Group
get
/organizations/{organizationId}/fhir/4/RequestGroup/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* | |||
versionId* |
Response
keyboard_arrow_down
Remove Request Group
delete
/organizations/{organizationId}/fhir/4/RequestGroup/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Search Get Request Group
get
/organizations/{organizationId}/fhir/4/RequestGroup
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
author | string | ||
authored | string | ||
code | string | ||
encounter | string | ||
group-identifier | string | ||
identifier | string | ||
instanties-canonical | string | ||
instanties-uri | string | ||
intent | string | ||
participant | string | ||
patient | string | ||
priority | string | ||
status | string | ||
subject | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Request Group
get
/organizations/{organizationId}/fhir/4/RequestGroup/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Request Group
post
/organizations/{organizationId}/fhir/4/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* | string | application/json|application/x-www-form-urlencoded | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
author | string | ||
authored | string | ||
code | string | ||
encounter | string | ||
group-identifier | string | ||
identifier | string | ||
instanties-canonical | string | ||
instanties-uri | string | ||
intent | string | ||
participant | string | ||
patient | string | ||
priority | string | ||
status | string | ||
subject | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a RequestGroup resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Allows a service to provide a unique, business identifier for the request. | |
instantiatesCanonical | array(canonical) | A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
instantiatesUri | array(uri) | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this request. | |
replaces | array(Reference) | Completed or terminated request(s) whose function is taken by this new request. | |
groupIdentifier | Identifier | A 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. | |
status | code | The current state of the request. For request groups, the status reflects the status of all the requests in the group. | |
intent | code | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | |
priority | code | Indicates how quickly the request should be addressed with respect to other requests. | |
code | CodeableConcept | A code that identifies what the overall request group is. | |
subject | Reference | The subject for which the request group was created. | |
encounter | Reference | Describes the context of the request group, if any. | |
authoredOn | dateTime | Indicates when the request group was created. | |
author | Reference | Provides a reference to the author of the request group. | |
reasonCode | array(CodeableConcept) | Describes the reason for the request group in coded or textual form. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this request group. | |
note | array(Annotation) | Provides a mechanism to communicate additional information about the response. | |
action | array(RequestGroup_Action) | The actions, if any, produced by the evaluation of the artifact. |
Response
keyboard_arrow_down
Update Request Group
put
/organizations/{organizationId}/fhir/4/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* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | This is a RequestGroup resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Allows a service to provide a unique, business identifier for the request. | |
instantiatesCanonical | array(canonical) | A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
instantiatesUri | array(uri) | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this request. | |
replaces | array(Reference) | Completed or terminated request(s) whose function is taken by this new request. | |
groupIdentifier | Identifier | A 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. | |
status | code | The current state of the request. For request groups, the status reflects the status of all the requests in the group. | |
intent | code | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | |
priority | code | Indicates how quickly the request should be addressed with respect to other requests. | |
code | CodeableConcept | A code that identifies what the overall request group is. | |
subject | Reference | The subject for which the request group was created. | |
encounter | Reference | Describes the context of the request group, if any. | |
authoredOn | dateTime | Indicates when the request group was created. | |
author | Reference | Provides a reference to the author of the request group. | |
reasonCode | array(CodeableConcept) | Describes the reason for the request group in coded or textual form. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this request group. | |
note | array(Annotation) | Provides a mechanism to communicate additional information about the response. | |
action | array(RequestGroup_Action) | The actions, if any, produced by the evaluation of the artifact. |
Response
keyboard_arrow_down