communications

Create Communication

post
/organizations/{organizationId}/fhir/4/Communication

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Communication resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
instantiatesCanonicalarray(canonical)The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
instantiatesUriarray(uri)The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
basedOnarray(Reference)An order, proposal or plan fulfilled in whole or in part by this Communication.
partOfarray(Reference)Part of this action.
inResponseToarray(Reference)Prior communication that this communication is in response to.
statuscodeThe status of the transmission.
statusReasonCodeableConceptCaptures the reason for the current state of the Communication.
categoryarray(CodeableConcept)The type of message conveyed such as alert, notification, reminder, instruction, etc.
prioritycodeCharacterizes how quickly the planned or in progress communication must be addressed. 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 was the focus of this communication.
topicCodeableConceptDescription of the purpose/content, similar to a subject line in an email.
aboutarray(Reference)Other resources that pertain to this communication and to which this communication should be associated.
encounterReferenceThe Encounter during which this Communication was created or to which the creation of this record is tightly associated.
sentdateTimeThe time when this communication was sent.
receiveddateTimeThe time when this communication arrived at the destination.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
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/4/Communication/{resourceId}

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that 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*This is a Communication resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
instantiatesCanonicalarray(canonical)The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
instantiatesUriarray(uri)The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
basedOnarray(Reference)An order, proposal or plan fulfilled in whole or in part by this Communication.
partOfarray(Reference)Part of this action.
inResponseToarray(Reference)Prior communication that this communication is in response to.
statuscodeThe status of the transmission.
statusReasonCodeableConceptCaptures the reason for the current state of the Communication.
categoryarray(CodeableConcept)The type of message conveyed such as alert, notification, reminder, instruction, etc.
prioritycodeCharacterizes how quickly the planned or in progress communication must be addressed. 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 was the focus of this communication.
topicCodeableConceptDescription of the purpose/content, similar to a subject line in an email.
aboutarray(Reference)Other resources that pertain to this communication and to which this communication should be associated.
encounterReferenceThe Encounter during which this Communication was created or to which the creation of this record is tightly associated.
sentdateTimeThe time when this communication was sent.
receiveddateTimeThe time when this communication arrived at the destination.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
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/4/Communication/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Communication

get
/organizations/{organizationId}/fhir/4/Communication/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Communication/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Communication

delete
/organizations/{organizationId}/fhir/4/Communication/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Communication

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

Request

Headers

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

Query params

_idstring
_languagestring
based-onstring
categorystring
encounterstring
identifierstring
instantiates-canonicalstring
instantiates-uristring
mediumstring
part-ofstring
patientstring
receivedstring
recipientstring
senderstring
sentstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Communication

get
/organizations/{organizationId}/fhir/4/Communication/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Communication/_search

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that 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
encounterstring
identifierstring
instantiates-canonicalstring
instantiates-uristring
mediumstring
part-ofstring
patientstring
receivedstring
recipientstring
senderstring
sentstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Communication resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
instantiatesCanonicalarray(canonical)The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
instantiatesUriarray(uri)The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
basedOnarray(Reference)An order, proposal or plan fulfilled in whole or in part by this Communication.
partOfarray(Reference)Part of this action.
inResponseToarray(Reference)Prior communication that this communication is in response to.
statuscodeThe status of the transmission.
statusReasonCodeableConceptCaptures the reason for the current state of the Communication.
categoryarray(CodeableConcept)The type of message conveyed such as alert, notification, reminder, instruction, etc.
prioritycodeCharacterizes how quickly the planned or in progress communication must be addressed. 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 was the focus of this communication.
topicCodeableConceptDescription of the purpose/content, similar to a subject line in an email.
aboutarray(Reference)Other resources that pertain to this communication and to which this communication should be associated.
encounterReferenceThe Encounter during which this Communication was created or to which the creation of this record is tightly associated.
sentdateTimeThe time when this communication was sent.
receiveddateTimeThe time when this communication arrived at the destination.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
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/4/Communication/{resourceId}

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Communication resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
instantiatesCanonicalarray(canonical)The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
instantiatesUriarray(uri)The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
basedOnarray(Reference)An order, proposal or plan fulfilled in whole or in part by this Communication.
partOfarray(Reference)Part of this action.
inResponseToarray(Reference)Prior communication that this communication is in response to.
statuscodeThe status of the transmission.
statusReasonCodeableConceptCaptures the reason for the current state of the Communication.
categoryarray(CodeableConcept)The type of message conveyed such as alert, notification, reminder, instruction, etc.
prioritycodeCharacterizes how quickly the planned or in progress communication must be addressed. 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 was the focus of this communication.
topicCodeableConceptDescription of the purpose/content, similar to a subject line in an email.
aboutarray(Reference)Other resources that pertain to this communication and to which this communication should be associated.
encounterReferenceThe Encounter during which this Communication was created or to which the creation of this record is tightly associated.
sentdateTimeThe time when this communication was sent.
receiveddateTimeThe time when this communication arrived at the destination.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
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