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.

Columns

Header row
# path type required description
0 resourceType string * Resource type identifier. Must be string "CommunicationRequest"
1 integer * Number of subrows
2 id string * Logical id of this artifact
groupIdentifier Identifier Composite request this is part of
3 groupIdentifier.use code usual | official | temp | secondary | old (If known)
groupIdentifier.type CodeableConcept Description of identifier
groupIdentifier.type.coding Coding Code defined by a terminology system
4 groupIdentifier.type.coding.system uri Identity of the terminology system
5 groupIdentifier.type.coding.version string Version of the system - if relevant
6 groupIdentifier.type.coding.code code Symbol in syntax defined by the system
7 groupIdentifier.type.coding.display string Representation defined by the system
8 groupIdentifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 groupIdentifier.type.text string Plain text representation of the concept
10 groupIdentifier.system uri The namespace for the identifier value
11 groupIdentifier.value string The value that is unique
groupIdentifier.period Period Time period when id is/was valid for use
12 groupIdentifier.period.start dateTime Starting time with inclusive boundary
13 groupIdentifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 status code draft | active | on-hold | revoked | completed | entered-in-error | unknown
statusReason CodeableConcept Reason for current status
statusReason.coding Coding Code defined by a terminology system
15 statusReason.coding.system uri Identity of the terminology system
16 statusReason.coding.version string Version of the system - if relevant
17 statusReason.coding.code code Symbol in syntax defined by the system
18 statusReason.coding.display string Representation defined by the system
19 statusReason.coding.userSelected boolean If this coding was chosen directly by the user
20 statusReason.text string Plain text representation of the concept
21 priority code routine | urgent | asap | stat
22 doNotPerform boolean True if request is prohibiting action
subject Reference Focus of message
23 subject.reference string Literal reference, Relative, internal or absolute URL
24 subject.type uri Type the reference refers to (e.g. "Patient")
subject.identifier Identifier Logical reference, when literal reference is not known
25 subject.identifier.use code usual | official | temp | secondary | old (If known)
subject.identifier.type CodeableConcept Description of identifier
subject.identifier.type.coding Coding Code defined by a terminology system
26 subject.identifier.type.coding.system uri Identity of the terminology system
27 subject.identifier.type.coding.version string Version of the system - if relevant
28 subject.identifier.type.coding.code code Symbol in syntax defined by the system
29 subject.identifier.type.coding.display string Representation defined by the system
30 subject.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
31 subject.identifier.type.text string Plain text representation of the concept
32 subject.identifier.system uri The namespace for the identifier value
33 subject.identifier.value string The value that is unique
subject.identifier.period Period Time period when id is/was valid for use
34 subject.identifier.period.start dateTime Starting time with inclusive boundary
35 subject.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
36 subject.display string Text alternative for the resource
encounter Reference Encounter created as part of
37 encounter.reference string Literal reference, Relative, internal or absolute URL
38 encounter.type uri Type the reference refers to (e.g. "Patient")
encounter.identifier Identifier Logical reference, when literal reference is not known
39 encounter.identifier.use code usual | official | temp | secondary | old (If known)
encounter.identifier.type CodeableConcept Description of identifier
encounter.identifier.type.coding Coding Code defined by a terminology system
40 encounter.identifier.type.coding.system uri Identity of the terminology system
41 encounter.identifier.type.coding.version string Version of the system - if relevant
42 encounter.identifier.type.coding.code code Symbol in syntax defined by the system
43 encounter.identifier.type.coding.display string Representation defined by the system
44 encounter.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
45 encounter.identifier.type.text string Plain text representation of the concept
46 encounter.identifier.system uri The namespace for the identifier value
47 encounter.identifier.value string The value that is unique
encounter.identifier.period Period Time period when id is/was valid for use
48 encounter.identifier.period.start dateTime Starting time with inclusive boundary
49 encounter.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
50 encounter.display string Text alternative for the resource
occurrence[x] When scheduled
51 occurrenceDateTime dateTime
occurrencePeriod Period
52 occurrencePeriod.start dateTime Starting time with inclusive boundary
53 occurrencePeriod.end dateTime End time with inclusive boundary, if not ongoing
54 authoredOn dateTime When request transitioned to being actionable
requester Reference Who/what is requesting service
55 requester.reference string Literal reference, Relative, internal or absolute URL
56 requester.type uri Type the reference refers to (e.g. "Patient")
requester.identifier Identifier Logical reference, when literal reference is not known
57 requester.identifier.use code usual | official | temp | secondary | old (If known)
requester.identifier.type CodeableConcept Description of identifier
requester.identifier.type.coding Coding Code defined by a terminology system
58 requester.identifier.type.coding.system uri Identity of the terminology system
59 requester.identifier.type.coding.version string Version of the system - if relevant
60 requester.identifier.type.coding.code code Symbol in syntax defined by the system
61 requester.identifier.type.coding.display string Representation defined by the system
62 requester.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
63 requester.identifier.type.text string Plain text representation of the concept
64 requester.identifier.system uri The namespace for the identifier value
65 requester.identifier.value string The value that is unique
requester.identifier.period Period Time period when id is/was valid for use
66 requester.identifier.period.start dateTime Starting time with inclusive boundary
67 requester.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
68 requester.display string Text alternative for the resource
sender Reference Message sender
69 sender.reference string Literal reference, Relative, internal or absolute URL
70 sender.type uri Type the reference refers to (e.g. "Patient")
sender.identifier Identifier Logical reference, when literal reference is not known
71 sender.identifier.use code usual | official | temp | secondary | old (If known)
sender.identifier.type CodeableConcept Description of identifier
sender.identifier.type.coding Coding Code defined by a terminology system
72 sender.identifier.type.coding.system uri Identity of the terminology system
73 sender.identifier.type.coding.version string Version of the system - if relevant
74 sender.identifier.type.coding.code code Symbol in syntax defined by the system
75 sender.identifier.type.coding.display string Representation defined by the system
76 sender.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
77 sender.identifier.type.text string Plain text representation of the concept
78 sender.identifier.system uri The namespace for the identifier value
79 sender.identifier.value string The value that is unique
sender.identifier.period Period Time period when id is/was valid for use
80 sender.identifier.period.start dateTime Starting time with inclusive boundary
81 sender.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
82 sender.display string Text alternative for the resource
Row identifier
# path type required description
0 string * Subrow identifier. Must be string "identifier"
identifier Identifier Unique identifier
1 identifier.use code usual | official | temp | secondary | old (If known)
identifier.type CodeableConcept Description of identifier
identifier.type.coding Coding Code defined by a terminology system
2 identifier.type.coding.system uri Identity of the terminology system
3 identifier.type.coding.version string Version of the system - if relevant
4 identifier.type.coding.code code Symbol in syntax defined by the system
5 identifier.type.coding.display string Representation defined by the system
6 identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
7 identifier.type.text string Plain text representation of the concept
8 identifier.system uri The namespace for the identifier value
9 identifier.value string The value that is unique
identifier.period Period Time period when id is/was valid for use
10 identifier.period.start dateTime Starting time with inclusive boundary
11 identifier.period.end dateTime End time with inclusive boundary, if not ongoing
Row basedOn
# path type required description
0 string * Subrow identifier. Must be string "basedOn"
basedOn Reference Fulfills plan or proposal
1 basedOn.reference string Literal reference, Relative, internal or absolute URL
2 basedOn.type uri Type the reference refers to (e.g. "Patient")
basedOn.identifier Identifier Logical reference, when literal reference is not known
3 basedOn.identifier.use code usual | official | temp | secondary | old (If known)
basedOn.identifier.type CodeableConcept Description of identifier
basedOn.identifier.type.coding Coding Code defined by a terminology system
4 basedOn.identifier.type.coding.system uri Identity of the terminology system
5 basedOn.identifier.type.coding.version string Version of the system - if relevant
6 basedOn.identifier.type.coding.code code Symbol in syntax defined by the system
7 basedOn.identifier.type.coding.display string Representation defined by the system
8 basedOn.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 basedOn.identifier.type.text string Plain text representation of the concept
10 basedOn.identifier.system uri The namespace for the identifier value
11 basedOn.identifier.value string The value that is unique
basedOn.identifier.period Period Time period when id is/was valid for use
12 basedOn.identifier.period.start dateTime Starting time with inclusive boundary
13 basedOn.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 basedOn.display string Text alternative for the resource
Row replaces
# path type required description
0 string * Subrow identifier. Must be string "replaces"
replaces Reference Request(s) replaced by this request
1 replaces.reference string Literal reference, Relative, internal or absolute URL
2 replaces.type uri Type the reference refers to (e.g. "Patient")
replaces.identifier Identifier Logical reference, when literal reference is not known
3 replaces.identifier.use code usual | official | temp | secondary | old (If known)
replaces.identifier.type CodeableConcept Description of identifier
replaces.identifier.type.coding Coding Code defined by a terminology system
4 replaces.identifier.type.coding.system uri Identity of the terminology system
5 replaces.identifier.type.coding.version string Version of the system - if relevant
6 replaces.identifier.type.coding.code code Symbol in syntax defined by the system
7 replaces.identifier.type.coding.display string Representation defined by the system
8 replaces.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 replaces.identifier.type.text string Plain text representation of the concept
10 replaces.identifier.system uri The namespace for the identifier value
11 replaces.identifier.value string The value that is unique
replaces.identifier.period Period Time period when id is/was valid for use
12 replaces.identifier.period.start dateTime Starting time with inclusive boundary
13 replaces.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 replaces.display string Text alternative for the resource
Row category
# path type required description
0 string * Subrow identifier. Must be string "category"
category CodeableConcept Message category
category.coding Coding Code defined by a terminology system
1 category.coding.system uri Identity of the terminology system
2 category.coding.version string Version of the system - if relevant
3 category.coding.code code Symbol in syntax defined by the system
4 category.coding.display string Representation defined by the system
5 category.coding.userSelected boolean If this coding was chosen directly by the user
6 category.text string Plain text representation of the concept
Row medium
# path type required description
0 string * Subrow identifier. Must be string "medium"
medium CodeableConcept A channel of communication
medium.coding Coding Code defined by a terminology system
1 medium.coding.system uri Identity of the terminology system
2 medium.coding.version string Version of the system - if relevant
3 medium.coding.code code Symbol in syntax defined by the system
4 medium.coding.display string Representation defined by the system
5 medium.coding.userSelected boolean If this coding was chosen directly by the user
6 medium.text string Plain text representation of the concept
Row about
# path type required description
0 string * Subrow identifier. Must be string "about"
about Reference Resources that pertain to this communication request
1 about.reference string Literal reference, Relative, internal or absolute URL
2 about.type uri Type the reference refers to (e.g. "Patient")
about.identifier Identifier Logical reference, when literal reference is not known
3 about.identifier.use code usual | official | temp | secondary | old (If known)
about.identifier.type CodeableConcept Description of identifier
about.identifier.type.coding Coding Code defined by a terminology system
4 about.identifier.type.coding.system uri Identity of the terminology system
5 about.identifier.type.coding.version string Version of the system - if relevant
6 about.identifier.type.coding.code code Symbol in syntax defined by the system
7 about.identifier.type.coding.display string Representation defined by the system
8 about.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 about.identifier.type.text string Plain text representation of the concept
10 about.identifier.system uri The namespace for the identifier value
11 about.identifier.value string The value that is unique
about.identifier.period Period Time period when id is/was valid for use
12 about.identifier.period.start dateTime Starting time with inclusive boundary
13 about.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 about.display string Text alternative for the resource
Row payload
# path type required description
0 string * Subrow identifier. Must be string "payload"
payload Message payload
payload.content[x] Message part content
1 payload.contentString string
payload.contentAttachment Attachment
2 payload.contentAttachment.contentType code Mime type of the content, with charset etc.
3 payload.contentAttachment.language code Human language of the content (BCP-47)
4 payload.contentAttachment.data base64Binary Data inline, base64ed
5 payload.contentAttachment.url url Uri where the data can be found
6 payload.contentAttachment.size unsignedInt Number of bytes of content (if url provided)
7 payload.contentAttachment.hash base64Binary Hash of the data (sha-1, base64ed)
8 payload.contentAttachment.title string Label to display in place of the data
9 payload.contentAttachment.creation dateTime Date attachment was first created
payload.contentReference Reference
10 payload.contentReference.reference string Literal reference, Relative, internal or absolute URL
11 payload.contentReference.type uri Type the reference refers to (e.g. "Patient")
payload.contentReference.identifier Identifier Logical reference, when literal reference is not known
12 payload.contentReference.identifier.use code usual | official | temp | secondary | old (If known)
payload.contentReference.identifier.type CodeableConcept Description of identifier
payload.contentReference.identifier.type.coding Coding Code defined by a terminology system
13 payload.contentReference.identifier.type.coding.system uri Identity of the terminology system
14 payload.contentReference.identifier.type.coding.version string Version of the system - if relevant
15 payload.contentReference.identifier.type.coding.code code Symbol in syntax defined by the system
16 payload.contentReference.identifier.type.coding.display string Representation defined by the system
17 payload.contentReference.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
18 payload.contentReference.identifier.type.text string Plain text representation of the concept
19 payload.contentReference.identifier.system uri The namespace for the identifier value
20 payload.contentReference.identifier.value string The value that is unique
payload.contentReference.identifier.period Period Time period when id is/was valid for use
21 payload.contentReference.identifier.period.start dateTime Starting time with inclusive boundary
22 payload.contentReference.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
23 payload.contentReference.display string Text alternative for the resource
Row recipient
# path type required description
0 string * Subrow identifier. Must be string "recipient"
recipient Reference Message recipient
1 recipient.reference string Literal reference, Relative, internal or absolute URL
2 recipient.type uri Type the reference refers to (e.g. "Patient")
recipient.identifier Identifier Logical reference, when literal reference is not known
3 recipient.identifier.use code usual | official | temp | secondary | old (If known)
recipient.identifier.type CodeableConcept Description of identifier
recipient.identifier.type.coding Coding Code defined by a terminology system
4 recipient.identifier.type.coding.system uri Identity of the terminology system
5 recipient.identifier.type.coding.version string Version of the system - if relevant
6 recipient.identifier.type.coding.code code Symbol in syntax defined by the system
7 recipient.identifier.type.coding.display string Representation defined by the system
8 recipient.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 recipient.identifier.type.text string Plain text representation of the concept
10 recipient.identifier.system uri The namespace for the identifier value
11 recipient.identifier.value string The value that is unique
recipient.identifier.period Period Time period when id is/was valid for use
12 recipient.identifier.period.start dateTime Starting time with inclusive boundary
13 recipient.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 recipient.display string Text alternative for the resource
Row reasonCode
# path type required description
0 string * Subrow identifier. Must be string "reasonCode"
reasonCode CodeableConcept Why is communication needed?
reasonCode.coding Coding Code defined by a terminology system
1 reasonCode.coding.system uri Identity of the terminology system
2 reasonCode.coding.version string Version of the system - if relevant
3 reasonCode.coding.code code Symbol in syntax defined by the system
4 reasonCode.coding.display string Representation defined by the system
5 reasonCode.coding.userSelected boolean If this coding was chosen directly by the user
6 reasonCode.text string Plain text representation of the concept
Row reasonReference
# path type required description
0 string * Subrow identifier. Must be string "reasonReference"
reasonReference Reference Why is communication needed?
1 reasonReference.reference string Literal reference, Relative, internal or absolute URL
2 reasonReference.type uri Type the reference refers to (e.g. "Patient")
reasonReference.identifier Identifier Logical reference, when literal reference is not known
3 reasonReference.identifier.use code usual | official | temp | secondary | old (If known)
reasonReference.identifier.type CodeableConcept Description of identifier
reasonReference.identifier.type.coding Coding Code defined by a terminology system
4 reasonReference.identifier.type.coding.system uri Identity of the terminology system
5 reasonReference.identifier.type.coding.version string Version of the system - if relevant
6 reasonReference.identifier.type.coding.code code Symbol in syntax defined by the system
7 reasonReference.identifier.type.coding.display string Representation defined by the system
8 reasonReference.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 reasonReference.identifier.type.text string Plain text representation of the concept
10 reasonReference.identifier.system uri The namespace for the identifier value
11 reasonReference.identifier.value string The value that is unique
reasonReference.identifier.period Period Time period when id is/was valid for use
12 reasonReference.identifier.period.start dateTime Starting time with inclusive boundary
13 reasonReference.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 reasonReference.display string Text alternative for the resource
Row note
# path type required description
0 string * Subrow identifier. Must be string "note"
note Annotation Comments made about communication request
note.author[x] Individual responsible for the annotation
note.authorReference Reference
1 note.authorReference.reference string Literal reference, Relative, internal or absolute URL
2 note.authorReference.type uri Type the reference refers to (e.g. "Patient")
note.authorReference.identifier Identifier Logical reference, when literal reference is not known
3 note.authorReference.identifier.use code usual | official | temp | secondary | old (If known)
note.authorReference.identifier.type CodeableConcept Description of identifier
note.authorReference.identifier.type.coding Coding Code defined by a terminology system
4 note.authorReference.identifier.type.coding.system uri Identity of the terminology system
5 note.authorReference.identifier.type.coding.version string Version of the system - if relevant
6 note.authorReference.identifier.type.coding.code code Symbol in syntax defined by the system
7 note.authorReference.identifier.type.coding.display string Representation defined by the system
8 note.authorReference.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 note.authorReference.identifier.type.text string Plain text representation of the concept
10 note.authorReference.identifier.system uri The namespace for the identifier value
11 note.authorReference.identifier.value string The value that is unique
note.authorReference.identifier.period Period Time period when id is/was valid for use
12 note.authorReference.identifier.period.start dateTime Starting time with inclusive boundary
13 note.authorReference.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 note.authorReference.display string Text alternative for the resource
15 note.authorString string
16 note.time dateTime When the annotation was made
17 note.text markdown The annotation - text content (as markdown)

Examples

Example #1
Input CSV
CommunicationRequest,7,"fm-solicit",,,,,,,,,"12345",,,"active",,,,,,,"routine",,,,,,,,,,,,,,,,"Encounter/example",,,,,,,,,,,,,,"2016-06-10T11:01:10-08:00",,,"2016-06-10T11:01:10-08:00","#requester",,,,,,,,,,,,,,"#payor",,,,,,,,,,,,,
identifier,,,,,,,,"http://www.jurisdiction.com/insurer/123456","ABC123",,
basedOn,,,,,,,,,,,,,,"EligibilityRequest"
replaces,,,,,,,,,,,,,,"prior CommunicationRequest"
category,"http://acme.org/messagetypes",,"SolicitedAttachmentRequest",,,
medium,"http://terminology.hl7.org/CodeSystem/v3-ParticipationMode",,"WRITTEN","written",,"written"
payload,"Please provide the accident report and any associated pictures to support your Claim# DEF5647.",,,,,,,,,,,,,,,,,,,,,,
recipient,"#provider",,,,,,,,,,,,,
Resulting resource
{
  "resourceType": "CommunicationRequest",
  "id": "fm-solicit",
  "identifier": [
    {
      "system": "http://www.jurisdiction.com/insurer/123456",
      "value": "ABC123"
    }
  ],
  "basedOn": [
    {
      "display": "EligibilityRequest"
    }
  ],
  "replaces": [
    {
      "display": "prior CommunicationRequest"
    }
  ],
  "groupIdentifier": {
    "value": "12345"
  },
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "http://acme.org/messagetypes",
          "code": "SolicitedAttachmentRequest"
        }
      ]
    }
  ],
  "priority": "routine",
  "medium": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode",
          "code": "WRITTEN",
          "display": "written"
        }
      ],
      "text": "written"
    }
  ],
  "encounter": {
    "reference": "Encounter/example"
  },
  "payload": [
    {
      "contentString": "Please provide the accident report and any associated pictures to support your Claim# DEF5647."
    }
  ],
  "occurrenceDateTime": "2016-06-10T11:01:10-08:00",
  "authoredOn": "2016-06-10T11:01:10-08:00",
  "requester": {
    "reference": "#requester"
  },
  "recipient": [
    {
      "reference": "#provider"
    }
  ],
  "sender": {
    "reference": "#payor"
  }
}
Example #2
Input CSV
CommunicationRequest,0,"example",,,,,,,,,,,,"active",,,,,,,,,"Patient/example",,,,,,,,,,,,,,"Encounter/example",,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
Resulting resource
{
  "resourceType": "CommunicationRequest",
  "id": "example",
  "status": "active",
  "subject": {
    "reference": "Patient/example"
  },
  "encounter": {
    "reference": "Encounter/example"
  }
}