CommunicationRequest - FHIR Resource (dstu2)


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

Validate an CommunicationRequest FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
categoryfalseCodeableConcept Message category
encounterfalseReference Encounter leading to message
identifiertrueIdentifier Unique identifier
mediumtrueCodeableConcept A channel of communication
payloadtrueData Type Message payload
priorityfalseCodeableConcept Message urgency
reasontrueCodeableConcept Indication for message
recipienttrueReference "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
requestedOnfalsedateTime When ordered or proposed
requesterfalseReference An individual who requested a communication
scheduledDateTimefalsedateTime "scheduledDateTime" : "<dateTime>",
scheduledPeriodfalsePeriod "scheduledPeriod" : { Period },
senderfalseReference "sender" : { Reference(Device|Organization|Patient|Practitioner|
statusfalsecode proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed
subjectfalseReference Focus of message

CommunicationRequest Structure


  
{
  "resourceType" : "CommunicationRequest",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier
  "category" : { CodeableConcept }, // Message category
  "sender" : { Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) }, // Message sender
  "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) }], // Message recipient
  "payload" : [{ // Message payload
    // content[x]: Message part content. One of these 3:
    "contentString" : "<string>"
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Any) }
  }],
  "medium" : [{ CodeableConcept }], // A channel of communication
  "requester" : { Reference(Practitioner|Patient|RelatedPerson) }, // An individual who requested a communication
  "status" : "<code>", // proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed
  "encounter" : { Reference(Encounter) }, // Encounter leading to message
  // scheduled[x]: When scheduled. One of these 2:
  "scheduledDateTime" : "<dateTime>",
  "scheduledPeriod" : { Period },
  "reason" : [{ CodeableConcept }], // Indication for message
  "requestedOn" : "<dateTime>", // When ordered or proposed
  "subject" : { Reference(Patient) }, // Focus of message
  "priority" : { CodeableConcept } // Message urgency
}


 

CommunicationRequest Search Parameters

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

https://api.1up.health/fhir/dstu2/CommunicationRequest?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
categorytextcategory
encounterreferenceencounter
identifiertextidentifier
mediumtextmedium
patientreferencesubject
prioritytextpriority
recipientreferencerecipient
requesteddaterequestedOn
requesterreferencerequester
senderreferencesender
statustextstatus
subjectreferencesubject
timedatescheduledDateTime