communication requests

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

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug

Body

resourceType*stringCommunicationRequestThis is a CommunicationRequest resource
identifierarray(Identifier)A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
basedOnarray(Reference)A plan or proposal 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 status of the proposal or order.
categoryarray(CodeableConcept)The type of message to be sent such as alert, notification, reminder, instruction, etc.
prioritystringCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
mediumarray(CodeableConcept)A channel that was used for this communication (e.g. email, fax).
subjectReferenceThe patient or group that is the focus of this communication request.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
topicarray(Reference)The resources which were related to producing this communication request.
contextReferenceThe encounter or episode of care within which the communication request was created.
payloadarray(CommunicationRequest_Payload)Text, attachment(s), or resource(s) to be communicated to the recipient.
occurrenceDateTimestringThe time when this communication is to occur.
occurrencePeriodPeriodThe time when this communication is to occur.
authoredOnstringFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
requesterCommunicationRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
reasonCodearray(CodeableConcept)Describes why the request is being made in coded or textual form.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request.
notearray(Annotation)Comments made about the request by the requester, sender, recipient, subject or other participants.

Response

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

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCommunicationRequestThis is a CommunicationRequest resource
identifierarray(Identifier)A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
basedOnarray(Reference)A plan or proposal 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 status of the proposal or order.
categoryarray(CodeableConcept)The type of message to be sent such as alert, notification, reminder, instruction, etc.
prioritystringCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
mediumarray(CodeableConcept)A channel that was used for this communication (e.g. email, fax).
subjectReferenceThe patient or group that is the focus of this communication request.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
topicarray(Reference)The resources which were related to producing this communication request.
contextReferenceThe encounter or episode of care within which the communication request was created.
payloadarray(CommunicationRequest_Payload)Text, attachment(s), or resource(s) to be communicated to the recipient.
occurrenceDateTimestringThe time when this communication is to occur.
occurrencePeriodPeriodThe time when this communication is to occur.
authoredOnstringFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
requesterCommunicationRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
reasonCodearray(CodeableConcept)Describes why the request is being made in coded or textual form.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request.
notearray(Annotation)Comments made about the request by the requester, sender, recipient, subject or other participants.

Response

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

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

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

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

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

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

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

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

Request

Headers

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

Query params

_idstring
_languagestring
authoredstring
based-onstring
categorystring
contextstring
encounterstring
group-identifierstring
identifierstring
mediumstring
occurrencestring
patientstring
prioritystring
recipientstring
replacesstring
requesterstring
senderstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

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

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

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

Request

Headers

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

Query params

_idstring
_languagestring
authoredstring
based-onstring
categorystring
contextstring
encounterstring
group-identifierstring
identifierstring
mediumstring
occurrencestring
patientstring
prioritystring
recipientstring
replacesstring
requesterstring
senderstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringCommunicationRequestThis is a CommunicationRequest resource
identifierarray(Identifier)A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
basedOnarray(Reference)A plan or proposal 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 status of the proposal or order.
categoryarray(CodeableConcept)The type of message to be sent such as alert, notification, reminder, instruction, etc.
prioritystringCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
mediumarray(CodeableConcept)A channel that was used for this communication (e.g. email, fax).
subjectReferenceThe patient or group that is the focus of this communication request.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
topicarray(Reference)The resources which were related to producing this communication request.
contextReferenceThe encounter or episode of care within which the communication request was created.
payloadarray(CommunicationRequest_Payload)Text, attachment(s), or resource(s) to be communicated to the recipient.
occurrenceDateTimestringThe time when this communication is to occur.
occurrencePeriodPeriodThe time when this communication is to occur.
authoredOnstringFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
requesterCommunicationRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
reasonCodearray(CodeableConcept)Describes why the request is being made in coded or textual form.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request.
notearray(Annotation)Comments made about the request by the requester, sender, recipient, subject or other participants.

Response

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

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCommunicationRequestThis is a CommunicationRequest resource
identifierarray(Identifier)A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
basedOnarray(Reference)A plan or proposal 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 status of the proposal or order.
categoryarray(CodeableConcept)The type of message to be sent such as alert, notification, reminder, instruction, etc.
prioritystringCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
mediumarray(CodeableConcept)A channel that was used for this communication (e.g. email, fax).
subjectReferenceThe patient or group that is the focus of this communication request.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
topicarray(Reference)The resources which were related to producing this communication request.
contextReferenceThe encounter or episode of care within which the communication request was created.
payloadarray(CommunicationRequest_Payload)Text, attachment(s), or resource(s) to be communicated to the recipient.
occurrenceDateTimestringThe time when this communication is to occur.
occurrencePeriodPeriodThe time when this communication is to occur.
authoredOnstringFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
requesterCommunicationRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
reasonCodearray(CodeableConcept)Describes why the request is being made in coded or textual form.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request.
notearray(Annotation)Comments made about the request by the requester, sender, recipient, subject or other participants.

Response