communication requests

Create Communication Request

post
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a CommunicationRequest 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 request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
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.
statuscodeThe status of the proposal or order.
statusReasonCodeableConceptCaptures the reason for the current state of the CommunicationRequest.
categoryarray(CodeableConcept)The type of message to be sent such as alert, notification, reminder, instruction, etc.
prioritycodeCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
doNotPerformbooleanIf true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
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.
aboutarray(Reference)Other resources that pertain to this communication request and to which this communication request should be associated.
encounterReferenceThe Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
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.
authoredOndateTimeFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
requesterReferenceThe device, individual, or organization who initiated the request and has responsibility for its activation.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
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 Communication Request

patch
/organizations/{organizationId}/fhir/4/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/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 CommunicationRequest 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 request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
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.
statuscodeThe status of the proposal or order.
statusReasonCodeableConceptCaptures the reason for the current state of the CommunicationRequest.
categoryarray(CodeableConcept)The type of message to be sent such as alert, notification, reminder, instruction, etc.
prioritycodeCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
doNotPerformbooleanIf true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
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.
aboutarray(Reference)Other resources that pertain to this communication request and to which this communication request should be associated.
encounterReferenceThe Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
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.
authoredOndateTimeFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
requesterReferenceThe device, individual, or organization who initiated the request and has responsibility for its activation.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
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

Read Communication Request

get
/organizations/{organizationId}/fhir/4/CommunicationRequest/{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 Request

get
/organizations/{organizationId}/fhir/4/CommunicationRequest/{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 Request

get
/organizations/{organizationId}/fhir/4/CommunicationRequest/{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 Request

delete
/organizations/{organizationId}/fhir/4/CommunicationRequest/{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 Request

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

Request

Headers

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

Query params

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

Params

organizationId*string|stringid|slug

Response

Search History Communication Request

get
/organizations/{organizationId}/fhir/4/CommunicationRequest/_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 Request

post
/organizations/{organizationId}/fhir/4/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
encounterstring
group-identifierstring
identifierstring
mediumstring
occurrencestring
patientstring
prioritystring
recipientstring
replacesstring
requesterstring
senderstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a CommunicationRequest 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 request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
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.
statuscodeThe status of the proposal or order.
statusReasonCodeableConceptCaptures the reason for the current state of the CommunicationRequest.
categoryarray(CodeableConcept)The type of message to be sent such as alert, notification, reminder, instruction, etc.
prioritycodeCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
doNotPerformbooleanIf true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
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.
aboutarray(Reference)Other resources that pertain to this communication request and to which this communication request should be associated.
encounterReferenceThe Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
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.
authoredOndateTimeFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
requesterReferenceThe device, individual, or organization who initiated the request and has responsibility for its activation.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
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

Update Communication Request

put
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a CommunicationRequest 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 request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
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.
statuscodeThe status of the proposal or order.
statusReasonCodeableConceptCaptures the reason for the current state of the CommunicationRequest.
categoryarray(CodeableConcept)The type of message to be sent such as alert, notification, reminder, instruction, etc.
prioritycodeCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
doNotPerformbooleanIf true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
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.
aboutarray(Reference)Other resources that pertain to this communication request and to which this communication request should be associated.
encounterReferenceThe Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
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.
authoredOndateTimeFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
requesterReferenceThe device, individual, or organization who initiated the request and has responsibility for its activation.
recipientarray(Reference)The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
senderReferenceThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
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