CommunicationRequest - FHIR Resource (stu3)


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

Resource Attributes

AttributeField is listTypeDescription
authoredOnfalsedateTime When request transitioned to being actionable
basedOntrueReference Fulfills plan or proposal
categorytrueCodeableConcept Message category
contextfalseReference Encounter or episode leading to message
groupIdentifierfalseIdentifier Composite request this is part of
identifiertrueIdentifier Unique identifier
mediumtrueCodeableConcept A channel of communication
notetrueAnnotation Comments made about communication request
occurrenceDateTimefalsedateTime "occurrenceDateTime" : "<dateTime>",
occurrencePeriodfalsePeriod "occurrencePeriod" : { Period },
payloadtrueData Type Message payload
priorityfalsecode Message urgency
reasonCodetrueCodeableConcept Why is communication needed?
reasonReferencetrueReference Why is communication needed?
recipienttrueReference "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
replacestrueReference Request(s) replaced by this request
requesterfalseData Type Who/what is requesting service
senderfalseReference "sender" : { Reference(Device|Organization|Patient|Practitioner|
statusfalsecode draft | active | suspended | cancelled | completed | entered-in-error | unknown
subjectfalseReference Focus of message
topictrueReference Focal resources

CommunicationRequest Example

{
  "status": "active",
  "resourceType": "CommunicationRequest",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">To be filled out at a later time</div>"
  },
  "context": {
    "reference": "Encounter/example"
  },
  "id": "example",
  "subject": {
    "reference": "Patient/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 | suspended | cancelled | completed | entered-in-error | unknown
  "category" : [{ CodeableConcept }], // Message category
  "priority" : "<code>", // Message urgency
  "medium" : [{ CodeableConcept }], // A channel of communication
  "subject" : { Reference(Patient|Group) }, // Focus of message
  "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson|Group|CareTeam) }], // Message recipient
  "topic" : [{ Reference(Any) }], // Focal resources
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or episode leading to message
  "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
  "sender" : { Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) }, // Message sender
  "requester" : { // Who/what is requesting service
    "agent" : { Reference(Practitioner|Organization|Patient|RelatedPerson|
    Device) }, // R!  Individual making the request
    "onBehalfOf" : { Reference(Organization) } // C? Organization agent is acting for
  },
  "reasonCode" : [{ CodeableConcept }], // Why is communication needed?
  "reasonReference" : [{ Reference(Condition|Observation) }], // 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 the like so:

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