communications

Create Communication

post

/organizations/{organizationId}/fhir/3/Communication

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was 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*	string	Communication	This is a Communication resource
identifier	array(Identifier)		Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definition	array(Reference)		A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
basedOn	array(Reference)		An order, proposal or plan fulfilled in whole or in part by this Communication.
partOf	array(Reference)		Part of this action.
status	string		The status of the transmission.
notDone	boolean		If true, indicates that the described communication event did not actually occur.
notDoneReason	CodeableConcept		Describes why the communication event did not occur in coded and/or textual form.
category	array(CodeableConcept)		The type of message conveyed such as alert, notification, reminder, instruction, etc.
medium	array(CodeableConcept)		A channel that was used for this communication (e.g. email, fax).
subject	Reference		The patient or group that was the focus of this communication.
recipient	array(Reference)		The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).
topic	array(Reference)		The resources which were responsible for or related to producing this communication.
context	Reference		The encounter within which the communication was sent.
sent	string		The time when this communication was sent.
received	string		The time when this communication arrived at the destination.
sender	Reference		The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
reasonCode	array(CodeableConcept)		The reason or justification for the communication.
reasonReference	array(Reference)		Indicates another resource whose existence justifies this communication.
payload	array(Communication_Payload)		Text, attachment(s), or resource(s) that was communicated to the recipient.
note	array(Annotation)		Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Response

201 400 401 404

Patch Communication

patch

/organizations/{organizationId}/fhir/3/Communication/{resourceId}

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was 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*	string	Communication	This is a Communication resource
identifier	array(Identifier)		Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definition	array(Reference)		A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
basedOn	array(Reference)		An order, proposal or plan fulfilled in whole or in part by this Communication.
partOf	array(Reference)		Part of this action.
status	string		The status of the transmission.
notDone	boolean		If true, indicates that the described communication event did not actually occur.
notDoneReason	CodeableConcept		Describes why the communication event did not occur in coded and/or textual form.
category	array(CodeableConcept)		The type of message conveyed such as alert, notification, reminder, instruction, etc.
medium	array(CodeableConcept)		A channel that was used for this communication (e.g. email, fax).
subject	Reference		The patient or group that was the focus of this communication.
recipient	array(Reference)		The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).
topic	array(Reference)		The resources which were responsible for or related to producing this communication.
context	Reference		The encounter within which the communication was sent.
sent	string		The time when this communication was sent.
received	string		The time when this communication arrived at the destination.
sender	Reference		The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
reasonCode	array(CodeableConcept)		The reason or justification for the communication.
reasonReference	array(Reference)		Indicates another resource whose existence justifies this communication.
payload	array(Communication_Payload)		Text, attachment(s), or resource(s) that was communicated to the recipient.
note	array(Annotation)		Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Response

200 201 400 401 404 409

Read Communication

get

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

200 401 404

Read History Communication

get

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

200 401 404

Read Version Communication

get

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

200 400 401 404

Remove Communication

delete

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

200 204 400 401 404 409

Search Get Communication

get

/organizations/{organizationId}/fhir/3/Communication

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
based-on	string
category	string
context	string
definition	string
encounter	string
identifier	string
medium	string
part-of	string
patient	string
received	string
recipient	string
sender	string
sent	string
status	string
subject	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Communication

get

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

200 401 404

Search Post Communication

post

/organizations/{organizationId}/fhir/3/Communication/_search

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was 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
based-on	string
category	string
context	string
definition	string
encounter	string
identifier	string
medium	string
part-of	string
patient	string
received	string
recipient	string
sender	string
sent	string
status	string
subject	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Communication	This is a Communication resource
identifier	array(Identifier)		Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definition	array(Reference)		A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
basedOn	array(Reference)		An order, proposal or plan fulfilled in whole or in part by this Communication.
partOf	array(Reference)		Part of this action.
status	string		The status of the transmission.
notDone	boolean		If true, indicates that the described communication event did not actually occur.
notDoneReason	CodeableConcept		Describes why the communication event did not occur in coded and/or textual form.
category	array(CodeableConcept)		The type of message conveyed such as alert, notification, reminder, instruction, etc.
medium	array(CodeableConcept)		A channel that was used for this communication (e.g. email, fax).
subject	Reference		The patient or group that was the focus of this communication.
recipient	array(Reference)		The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).
topic	array(Reference)		The resources which were responsible for or related to producing this communication.
context	Reference		The encounter within which the communication was sent.
sent	string		The time when this communication was sent.
received	string		The time when this communication arrived at the destination.
sender	Reference		The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
reasonCode	array(CodeableConcept)		The reason or justification for the communication.
reasonReference	array(Reference)		Indicates another resource whose existence justifies this communication.
payload	array(Communication_Payload)		Text, attachment(s), or resource(s) that was communicated to the recipient.
note	array(Annotation)		Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Response

200 401 404

Update Communication

put

/organizations/{organizationId}/fhir/3/Communication/{resourceId}

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was 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*	string	Communication	This is a Communication resource
identifier	array(Identifier)		Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definition	array(Reference)		A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
basedOn	array(Reference)		An order, proposal or plan fulfilled in whole or in part by this Communication.
partOf	array(Reference)		Part of this action.
status	string		The status of the transmission.
notDone	boolean		If true, indicates that the described communication event did not actually occur.
notDoneReason	CodeableConcept		Describes why the communication event did not occur in coded and/or textual form.
category	array(CodeableConcept)		The type of message conveyed such as alert, notification, reminder, instruction, etc.
medium	array(CodeableConcept)		A channel that was used for this communication (e.g. email, fax).
subject	Reference		The patient or group that was the focus of this communication.
recipient	array(Reference)		The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).
topic	array(Reference)		The resources which were responsible for or related to producing this communication.
context	Reference		The encounter within which the communication was sent.
sent	string		The time when this communication was sent.
received	string		The time when this communication arrived at the destination.
sender	Reference		The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
reasonCode	array(CodeableConcept)		The reason or justification for the communication.
reasonReference	array(Reference)		Indicates another resource whose existence justifies this communication.
payload	array(Communication_Payload)		Text, attachment(s), or resource(s) that was communicated to the recipient.
note	array(Annotation)		Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Response

200 201 400 401 404 409