guidance responses

Create Guidance Response

post
/organizations/{organizationId}/fhir/3/GuidanceResponse

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringGuidanceResponseThis is a GuidanceResponse resource
requestIdstringThe id of the request associated with this response. If an id was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.
identifierIdentifierAllows a service to provide a unique, business identifier for the response.
module*ReferenceA reference to the knowledge module that was invoked.
statusstringsuccess|data-requested|data-required|in-progress|failure|entered-in-errorThe status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
subjectReferenceThe patient for which the request was processed.
contextReferenceAllows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.
occurrenceDateTimestringIndicates when the guidance response was processed.
performerReferenceProvides a reference to the device that performed the guidance.
reasonCodeableConceptCodeableConceptIndicates the reason the request was initiated. 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 was initiated. 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.
evaluationMessagearray(Reference)Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.
outputParametersReferenceThe output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.
resultReferenceThe actions, if any, produced by the evaluation of the artifact.
dataRequirementarray(DataRequirement)If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

Response

Patch Guidance Response

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

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

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*stringGuidanceResponseThis is a GuidanceResponse resource
requestIdstringThe id of the request associated with this response. If an id was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.
identifierIdentifierAllows a service to provide a unique, business identifier for the response.
module*ReferenceA reference to the knowledge module that was invoked.
statusstringsuccess|data-requested|data-required|in-progress|failure|entered-in-errorThe status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
subjectReferenceThe patient for which the request was processed.
contextReferenceAllows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.
occurrenceDateTimestringIndicates when the guidance response was processed.
performerReferenceProvides a reference to the device that performed the guidance.
reasonCodeableConceptCodeableConceptIndicates the reason the request was initiated. 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 was initiated. 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.
evaluationMessagearray(Reference)Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.
outputParametersReferenceThe output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.
resultReferenceThe actions, if any, produced by the evaluation of the artifact.
dataRequirementarray(DataRequirement)If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

Response

Read Guidance Response

get
/organizations/{organizationId}/fhir/3/GuidanceResponse/{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 Guidance Response

get
/organizations/{organizationId}/fhir/3/GuidanceResponse/{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 Guidance Response

get
/organizations/{organizationId}/fhir/3/GuidanceResponse/{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 Guidance Response

delete
/organizations/{organizationId}/fhir/3/GuidanceResponse/{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 Guidance Response

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

Request

Headers

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

Query params

_idstring
_languagestring
identifierstring
patientstring
requeststring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Guidance Response

get
/organizations/{organizationId}/fhir/3/GuidanceResponse/_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 Guidance Response

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

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

Request

Headers

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

Query params

_idstring
_languagestring
identifierstring
patientstring
requeststring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringGuidanceResponseThis is a GuidanceResponse resource
requestIdstringThe id of the request associated with this response. If an id was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.
identifierIdentifierAllows a service to provide a unique, business identifier for the response.
module*ReferenceA reference to the knowledge module that was invoked.
statusstringsuccess|data-requested|data-required|in-progress|failure|entered-in-errorThe status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
subjectReferenceThe patient for which the request was processed.
contextReferenceAllows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.
occurrenceDateTimestringIndicates when the guidance response was processed.
performerReferenceProvides a reference to the device that performed the guidance.
reasonCodeableConceptCodeableConceptIndicates the reason the request was initiated. 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 was initiated. 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.
evaluationMessagearray(Reference)Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.
outputParametersReferenceThe output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.
resultReferenceThe actions, if any, produced by the evaluation of the artifact.
dataRequirementarray(DataRequirement)If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

Response

Update Guidance Response

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

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringGuidanceResponseThis is a GuidanceResponse resource
requestIdstringThe id of the request associated with this response. If an id was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.
identifierIdentifierAllows a service to provide a unique, business identifier for the response.
module*ReferenceA reference to the knowledge module that was invoked.
statusstringsuccess|data-requested|data-required|in-progress|failure|entered-in-errorThe status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
subjectReferenceThe patient for which the request was processed.
contextReferenceAllows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.
occurrenceDateTimestringIndicates when the guidance response was processed.
performerReferenceProvides a reference to the device that performed the guidance.
reasonCodeableConceptCodeableConceptIndicates the reason the request was initiated. 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 was initiated. 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.
evaluationMessagearray(Reference)Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.
outputParametersReferenceThe output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.
resultReferenceThe actions, if any, produced by the evaluation of the artifact.
dataRequirementarray(DataRequirement)If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

Response