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

Params

organizationId*string|stringid|slug

Body

resourceType*stringCommunicationThis is a Communication resource
identifierarray(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).
definitionarray(Reference)A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
basedOnarray(Reference)An order, proposal or plan fulfilled in whole or in part by this Communication.
partOfarray(Reference)Part of this action.
statusstringThe status of the transmission.
notDonebooleanIf true, indicates that the described communication event did not actually occur.
notDoneReasonCodeableConceptDescribes why the communication event did not occur in coded and/or textual form.
categoryarray(CodeableConcept)The type of message conveyed such as alert, notification, reminder, instruction, etc.
mediumarray(CodeableConcept)A channel that was used for this communication (e.g. email, fax).
subjectReferenceThe patient or group that was the focus of this communication.
recipientarray(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).
topicarray(Reference)The resources which were responsible for or related to producing this communication.
contextReferenceThe encounter within which the communication was sent.
sentstringThe time when this communication was sent.
receivedstringThe time when this communication arrived at the destination.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
reasonCodearray(CodeableConcept)The reason or justification for the communication.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this communication.
payloadarray(Communication_Payload)Text, attachment(s), or resource(s) that was communicated to the recipient.
notearray(Annotation)Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Response

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCommunicationThis is a Communication resource
identifierarray(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).
definitionarray(Reference)A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
basedOnarray(Reference)An order, proposal or plan fulfilled in whole or in part by this Communication.
partOfarray(Reference)Part of this action.
statusstringThe status of the transmission.
notDonebooleanIf true, indicates that the described communication event did not actually occur.
notDoneReasonCodeableConceptDescribes why the communication event did not occur in coded and/or textual form.
categoryarray(CodeableConcept)The type of message conveyed such as alert, notification, reminder, instruction, etc.
mediumarray(CodeableConcept)A channel that was used for this communication (e.g. email, fax).
subjectReferenceThe patient or group that was the focus of this communication.
recipientarray(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).
topicarray(Reference)The resources which were responsible for or related to producing this communication.
contextReferenceThe encounter within which the communication was sent.
sentstringThe time when this communication was sent.
receivedstringThe time when this communication arrived at the destination.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
reasonCodearray(CodeableConcept)The reason or justification for the communication.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this communication.
payloadarray(Communication_Payload)Text, attachment(s), or resource(s) that was communicated to the recipient.
notearray(Annotation)Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Response

Read Communication

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
based-onstring
categorystring
contextstring
definitionstring
encounterstring
identifierstring
mediumstring
part-ofstring
patientstring
receivedstring
recipientstring
senderstring
sentstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Communication

get
/organizations/{organizationId}/fhir/3/Communication/_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 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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
based-onstring
categorystring
contextstring
definitionstring
encounterstring
identifierstring
mediumstring
part-ofstring
patientstring
receivedstring
recipientstring
senderstring
sentstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringCommunicationThis is a Communication resource
identifierarray(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).
definitionarray(Reference)A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
basedOnarray(Reference)An order, proposal or plan fulfilled in whole or in part by this Communication.
partOfarray(Reference)Part of this action.
statusstringThe status of the transmission.
notDonebooleanIf true, indicates that the described communication event did not actually occur.
notDoneReasonCodeableConceptDescribes why the communication event did not occur in coded and/or textual form.
categoryarray(CodeableConcept)The type of message conveyed such as alert, notification, reminder, instruction, etc.
mediumarray(CodeableConcept)A channel that was used for this communication (e.g. email, fax).
subjectReferenceThe patient or group that was the focus of this communication.
recipientarray(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).
topicarray(Reference)The resources which were responsible for or related to producing this communication.
contextReferenceThe encounter within which the communication was sent.
sentstringThe time when this communication was sent.
receivedstringThe time when this communication arrived at the destination.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
reasonCodearray(CodeableConcept)The reason or justification for the communication.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this communication.
payloadarray(Communication_Payload)Text, attachment(s), or resource(s) that was communicated to the recipient.
notearray(Annotation)Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Response

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCommunicationThis is a Communication resource
identifierarray(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).
definitionarray(Reference)A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
basedOnarray(Reference)An order, proposal or plan fulfilled in whole or in part by this Communication.
partOfarray(Reference)Part of this action.
statusstringThe status of the transmission.
notDonebooleanIf true, indicates that the described communication event did not actually occur.
notDoneReasonCodeableConceptDescribes why the communication event did not occur in coded and/or textual form.
categoryarray(CodeableConcept)The type of message conveyed such as alert, notification, reminder, instruction, etc.
mediumarray(CodeableConcept)A channel that was used for this communication (e.g. email, fax).
subjectReferenceThe patient or group that was the focus of this communication.
recipientarray(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).
topicarray(Reference)The resources which were responsible for or related to producing this communication.
contextReferenceThe encounter within which the communication was sent.
sentstringThe time when this communication was sent.
receivedstringThe time when this communication arrived at the destination.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
reasonCodearray(CodeableConcept)The reason or justification for the communication.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this communication.
payloadarray(Communication_Payload)Text, attachment(s), or resource(s) that was communicated to the recipient.
notearray(Annotation)Additional notes or commentary about the communication by the sender, receiver or other interested parties.

Response