CommunicationRequest - FHIR Resource (r4)


This CommunicationRequest Resource uses the FHIR API standard for access and structure.

Validate an CommunicationRequest FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
abouttrueReference# Resources that pertain to this communication request
authoredOnfalsedateTime# When request transitioned to being actionable
basedOntrueReference# Fulfills plan or proposal
categorytrueCodeableConcept# Message category
doNotPerformfalseboolean# True if request is prohibiting action
encounterfalseReference# Encounter created as part of
groupIdentifierfalseIdentifier# Composite request this is part of
identifiertrueIdentifier# Unique identifier
mediumtrueCodeableConcept# A channel of communication
notetrueAnnotation# Comments made about communication request
occurrence[x]falsedateTime|Period#undefined
payloadtrueData Type# Message payload
priorityfalsecode# routine | urgent | asap | stat
reasonCodetrueCodeableConcept# Why is communication needed?
reasonReferencetrueReference# "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
recipienttrueReference# "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
replacestrueReference# Request(s) replaced by this request
requesterfalseReference# "requester" : { Reference(Practitioner|PractitionerRole|Organization|
senderfalseReference# "sender" : { Reference(Device|Organization|Patient|Practitioner|
statusfalsecode# draft | active | on-hold | revoked | completed | entered-in-error | unknown
statusReasonfalseCodeableConcept# Reason for current status
subjectfalseReference# Focus of message

CommunicationRequest Example

{
  "resourceType": "CommunicationRequest",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">To be filled out at a later time</div>"
  },
  "status": "active",
  "subject": {
    "reference": "Patient/example"
  },
  "encounter": {
    "reference": "Encounter/example"
  }
}

CommunicationRequest Structure

{
  "resourceType" : "CommunicationRequest",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier
  "basedOn" : [{ Reference(Any) }], // Fulfills plan or proposal
  "replaces" : [{ Reference(CommunicationRequest) }], // Request(s) replaced by this request
  "groupIdentifier" : { Identifier }, // Composite request this is part of
  "status" : "<code>", // R!  draft | active | on-hold | revoked | completed | entered-in-error | unknown
  "statusReason" : { CodeableConcept }, // Reason for current status
  "category" : [{ CodeableConcept }], // Message category
  "priority" : "<code>", // routine | urgent | asap | stat
  "doNotPerform" : <boolean>, // True if request is prohibiting action
  "medium" : [{ CodeableConcept }], // A channel of communication
  "subject" : { Reference(Patient|Group) }, // Focus of message
  "about" : [{ Reference(Any) }], // Resources that pertain to this communication request
  "encounter" : { Reference(Encounter) }, // Encounter created as part of
  "payload" : [{ // Message payload
    // content[x]: Message part content. One of these 3:
    "contentString" : "<string>"
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Any) }
  }],
  // occurrence[x]: When scheduled. One of these 2:
  "occurrenceDateTime" : "<dateTime>",
  "occurrencePeriod" : { Period },
  "authoredOn" : "<dateTime>", // When request transitioned to being actionable
  "requester" : { Reference(Practitioner|PractitionerRole|Organization|
   Patient|RelatedPerson|Device) }, // Who/what is requesting service
  "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) }], // Message recipient
  "sender" : { Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|HealthcareService) }, // Message sender
  "reasonCode" : [{ CodeableConcept }], // Why is communication needed?
  "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) }], // Why is communication needed?
  "note" : [{ Annotation }] // Comments made about communication request
}

CommunicationRequest Search Parameters

The following search parameters can be used to query CommunicationRequest resources. Just submit them like so:

https://api.1up.health/fhir/r4/CommunicationRequest?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authoreddateauthoredOn
based-onreferencebasedOn
categorytextcategory
encounterreferenceencounter
group-identifiertextgroupIdentifier
identifiertextidentifier
mediumtextmedium
occurrencedateoccurrence
patientreferencesubject.where
prioritytextpriority
recipientreferencerecipient
replacesreferencereplaces
requesterreferencerequester
senderreferencesender
statustextstatus
subjectreferencesubject