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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a RequestGroup resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Allows a service to provide a unique, business identifier for the request.
instantiatesCanonicalarray(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.
instantiatesUriarray(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.
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.
statuscodeThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentcodeIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
prioritycodeIndicates how quickly the request should be addressed with respect to other requests.
codeCodeableConceptA code that identifies what the overall request group is.
subjectReferenceThe subject for which the request group was created.
encounterReferenceDescribes the context of the request group, if any.
authoredOndateTimeIndicates when the request group was created.
authorReferenceProvides a reference to the author of the request group.
reasonCodearray(CodeableConcept)Describes the reason for the request group in coded or textual form.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request group.
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/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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a RequestGroup resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Allows a service to provide a unique, business identifier for the request.
instantiatesCanonicalarray(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.
instantiatesUriarray(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.
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.
statuscodeThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentcodeIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
prioritycodeIndicates how quickly the request should be addressed with respect to other requests.
codeCodeableConceptA code that identifies what the overall request group is.
subjectReferenceThe subject for which the request group was created.
encounterReferenceDescribes the context of the request group, if any.
authoredOndateTimeIndicates when the request group was created.
authorReferenceProvides a reference to the author of the request group.
reasonCodearray(CodeableConcept)Describes the reason for the request group in coded or textual form.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request group.
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/4/RequestGroup/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Request Group

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/RequestGroup/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Request Group

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Request Group

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

Request

Headers

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

Query params

_idstring
_languagestring
authorstring
authoredstring
codestring
encounterstring
group-identifierstring
identifierstring
instanties-canonicalstring
instanties-uristring
intentstring
participantstring
patientstring
prioritystring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Request Group

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
authoredstring
codestring
encounterstring
group-identifierstring
identifierstring
instanties-canonicalstring
instanties-uristring
intentstring
participantstring
patientstring
prioritystring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a RequestGroup resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Allows a service to provide a unique, business identifier for the request.
instantiatesCanonicalarray(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.
instantiatesUriarray(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.
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.
statuscodeThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentcodeIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
prioritycodeIndicates how quickly the request should be addressed with respect to other requests.
codeCodeableConceptA code that identifies what the overall request group is.
subjectReferenceThe subject for which the request group was created.
encounterReferenceDescribes the context of the request group, if any.
authoredOndateTimeIndicates when the request group was created.
authorReferenceProvides a reference to the author of the request group.
reasonCodearray(CodeableConcept)Describes the reason for the request group in coded or textual form.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request group.
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/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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a RequestGroup resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Allows a service to provide a unique, business identifier for the request.
instantiatesCanonicalarray(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.
instantiatesUriarray(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.
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.
statuscodeThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentcodeIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
prioritycodeIndicates how quickly the request should be addressed with respect to other requests.
codeCodeableConceptA code that identifies what the overall request group is.
subjectReferenceThe subject for which the request group was created.
encounterReferenceDescribes the context of the request group, if any.
authoredOndateTimeIndicates when the request group was created.
authorReferenceProvides a reference to the author of the request group.
reasonCodearray(CodeableConcept)Describes the reason for the request group in coded or textual form.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request group.
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