communication requests
Create Communication Request
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* | 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 CommunicationRequest 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) | Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | |
basedOn | array(Reference) | A plan or proposal 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 status of the proposal or order. | |
statusReason | CodeableConcept | Captures the reason for the current state of the CommunicationRequest. | |
category | array(CodeableConcept) | The type of message to be sent such as alert, notification, reminder, instruction, etc. | |
priority | code | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. | |
doNotPerform | boolean | If true indicates that the CommunicationRequest is asking for the specified action to *not* occur. | |
medium | array(CodeableConcept) | A channel that was used for this communication (e.g. email, fax). | |
subject | Reference | The patient or group that is the focus of this communication request. | |
about | array(Reference) | Other resources that pertain to this communication request and to which this communication request should be associated. | |
encounter | Reference | The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. | |
payload | array(CommunicationRequest_Payload) | Text, attachment(s), or resource(s) to be communicated to the recipient. | |
occurrenceDateTime | string | The time when this communication is to occur. | |
occurrencePeriod | Period | The time when this communication is to occur. | |
authoredOn | dateTime | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. | |
requester | Reference | The device, individual, or organization who initiated the request and has responsibility for its activation. | |
recipient | array(Reference) | The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. | |
sender | Reference | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | |
reasonCode | array(CodeableConcept) | Describes why the request is being made in coded or textual form. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this request. | |
note | array(Annotation) | Comments made about the request by the requester, sender, recipient, subject or other participants. |
Response
Patch Communication Request
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* | 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 CommunicationRequest 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) | Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | |
basedOn | array(Reference) | A plan or proposal 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 status of the proposal or order. | |
statusReason | CodeableConcept | Captures the reason for the current state of the CommunicationRequest. | |
category | array(CodeableConcept) | The type of message to be sent such as alert, notification, reminder, instruction, etc. | |
priority | code | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. | |
doNotPerform | boolean | If true indicates that the CommunicationRequest is asking for the specified action to *not* occur. | |
medium | array(CodeableConcept) | A channel that was used for this communication (e.g. email, fax). | |
subject | Reference | The patient or group that is the focus of this communication request. | |
about | array(Reference) | Other resources that pertain to this communication request and to which this communication request should be associated. | |
encounter | Reference | The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. | |
payload | array(CommunicationRequest_Payload) | Text, attachment(s), or resource(s) to be communicated to the recipient. | |
occurrenceDateTime | string | The time when this communication is to occur. | |
occurrencePeriod | Period | The time when this communication is to occur. | |
authoredOn | dateTime | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. | |
requester | Reference | The device, individual, or organization who initiated the request and has responsibility for its activation. | |
recipient | array(Reference) | The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. | |
sender | Reference | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | |
reasonCode | array(CodeableConcept) | Describes why the request is being made in coded or textual form. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this request. | |
note | array(Annotation) | Comments made about the request by the requester, sender, recipient, subject or other participants. |
Response
Read Communication Request
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
Read History Communication Request
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
Read Version Communication Request
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
Remove Communication Request
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
Search Get Communication Request
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 | ||
authored | string | ||
based-on | string | ||
category | string | ||
encounter | string | ||
group-identifier | string | ||
identifier | string | ||
medium | string | ||
occurrence | string | ||
patient | string | ||
priority | string | ||
recipient | string | ||
replaces | string | ||
requester | string | ||
sender | string | ||
status | string | ||
subject | string |
Params
organizationId* | string|string | id|slug |
Response
Search History Communication Request
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
Search Post Communication Request
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* | 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 | ||
authored | string | ||
based-on | string | ||
category | string | ||
encounter | string | ||
group-identifier | string | ||
identifier | string | ||
medium | string | ||
occurrence | string | ||
patient | string | ||
priority | string | ||
recipient | string | ||
replaces | string | ||
requester | string | ||
sender | string | ||
status | string | ||
subject | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a CommunicationRequest 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) | Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | |
basedOn | array(Reference) | A plan or proposal 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 status of the proposal or order. | |
statusReason | CodeableConcept | Captures the reason for the current state of the CommunicationRequest. | |
category | array(CodeableConcept) | The type of message to be sent such as alert, notification, reminder, instruction, etc. | |
priority | code | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. | |
doNotPerform | boolean | If true indicates that the CommunicationRequest is asking for the specified action to *not* occur. | |
medium | array(CodeableConcept) | A channel that was used for this communication (e.g. email, fax). | |
subject | Reference | The patient or group that is the focus of this communication request. | |
about | array(Reference) | Other resources that pertain to this communication request and to which this communication request should be associated. | |
encounter | Reference | The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. | |
payload | array(CommunicationRequest_Payload) | Text, attachment(s), or resource(s) to be communicated to the recipient. | |
occurrenceDateTime | string | The time when this communication is to occur. | |
occurrencePeriod | Period | The time when this communication is to occur. | |
authoredOn | dateTime | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. | |
requester | Reference | The device, individual, or organization who initiated the request and has responsibility for its activation. | |
recipient | array(Reference) | The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. | |
sender | Reference | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | |
reasonCode | array(CodeableConcept) | Describes why the request is being made in coded or textual form. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this request. | |
note | array(Annotation) | Comments made about the request by the requester, sender, recipient, subject or other participants. |
Response
Update Communication Request
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* | 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 CommunicationRequest 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) | Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | |
basedOn | array(Reference) | A plan or proposal 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 status of the proposal or order. | |
statusReason | CodeableConcept | Captures the reason for the current state of the CommunicationRequest. | |
category | array(CodeableConcept) | The type of message to be sent such as alert, notification, reminder, instruction, etc. | |
priority | code | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. | |
doNotPerform | boolean | If true indicates that the CommunicationRequest is asking for the specified action to *not* occur. | |
medium | array(CodeableConcept) | A channel that was used for this communication (e.g. email, fax). | |
subject | Reference | The patient or group that is the focus of this communication request. | |
about | array(Reference) | Other resources that pertain to this communication request and to which this communication request should be associated. | |
encounter | Reference | The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. | |
payload | array(CommunicationRequest_Payload) | Text, attachment(s), or resource(s) to be communicated to the recipient. | |
occurrenceDateTime | string | The time when this communication is to occur. | |
occurrencePeriod | Period | The time when this communication is to occur. | |
authoredOn | dateTime | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. | |
requester | Reference | The device, individual, or organization who initiated the request and has responsibility for its activation. | |
recipient | array(Reference) | The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. | |
sender | Reference | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | |
reasonCode | array(CodeableConcept) | Describes why the request is being made in coded or textual form. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this request. | |
note | array(Annotation) | Comments made about the request by the requester, sender, recipient, subject or other participants. |