Da Vinci Clinical Data Exchange (CDex) Implementation Guide Release 0.1.0

This page is part of the Da Vinci Clinical Documentation Exchange (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

SD.4 StructureDefinition-cdex-communicationrequest

title: StructureDefinition-cdex-communicationrequest-intro layout: default active: StructureDefinition-cdex-communicationrequest-intro —

SD.4.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-communicationrequest

Published on Thu Jun 20 16:38:59 EDT 2019 as a active by .

This profile builds on CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*
... subject S1..1Reference(US Core Patient Profile)
... payload S1..*BackboneElement
.... cdex-payload-query-string S0..1stringExtension
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-query-string
.... cdex-payload-clinical-note-type S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-clinical-note-type
Binding: Clinical Note Type (extensible)
.... content[x] S1..1string, Attachment, Reference(Resource)
... requester 1..1Reference(HRex PractitionerRole | HRex Organization)The person or organization creating the CommunicationRequest
... recipient S1..*Reference(HRex Organization)The recipient(s) of the Communication resulting from this request (not the recipient of the request).
... sender S1..1Reference(HRex Organization)The sender of the Communication resulting from this request (not the sender of the request).
... note S0..*AnnotationAdditional human readable info about the request, such as "Requesting discharge summary but if unavailable please send alternative documentation supporting the claim".

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*A request for information to be sent to a receiver
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... basedOn Σ0..*Reference(Resource)Fulfills plan or proposal
... replaces Σ0..*Reference(CommunicationRequest)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example)
... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority Σ0..1codeMessage urgency
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject S1..1Reference(US Core Patient Profile)Focus of message
... about 0..*Reference(Resource)Resources that pertain to this communication request
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... payload SI1..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... cdex-payload-query-string S0..1stringExtension
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-query-string
.... cdex-payload-clinical-note-type S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-clinical-note-type
Binding: Clinical Note Type (extensible)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] S1..1string, Attachment, Reference(Resource)Message part content
... occurrence[x] Σ0..1dateTime, PeriodWhen scheduled
... authoredOn Σ0..1dateTimeWhen request transitioned to being actionable
... requester Σ1..1Reference(HRex PractitionerRole | HRex Organization)The person or organization creating the CommunicationRequest
... recipient S1..*Reference(HRex Organization)The recipient(s) of the Communication resulting from this request (not the recipient of the request).
... sender SΣ1..1Reference(HRex Organization)The sender of the Communication resulting from this request (not the sender of the request).
... reasonCode Σ0..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why is communication needed?
... note S0..*AnnotationAdditional human readable info about the request, such as "Requesting discharge summary but if unavailable please send alternative documentation supporting the claim".

doco Documentation for this format
{% include StructureDefinition-cdex-communicationrequest-pseudo-xml.xhtml %}
{% include StructureDefinition-cdex-communicationrequest-pseudo-json.xhtml %}

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*
... subject S1..1Reference(US Core Patient Profile)
... payload S1..*BackboneElement
.... cdex-payload-query-string S0..1stringExtension
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-query-string
.... cdex-payload-clinical-note-type S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-clinical-note-type
Binding: Clinical Note Type (extensible)
.... content[x] S1..1string, Attachment, Reference(Resource)
... requester 1..1Reference(HRex PractitionerRole | HRex Organization)The person or organization creating the CommunicationRequest
... recipient S1..*Reference(HRex Organization)The recipient(s) of the Communication resulting from this request (not the recipient of the request).
... sender S1..1Reference(HRex Organization)The sender of the Communication resulting from this request (not the sender of the request).
... note S0..*AnnotationAdditional human readable info about the request, such as "Requesting discharge summary but if unavailable please send alternative documentation supporting the claim".

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*A request for information to be sent to a receiver
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... basedOn Σ0..*Reference(Resource)Fulfills plan or proposal
... replaces Σ0..*Reference(CommunicationRequest)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example)
... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority Σ0..1codeMessage urgency
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject S1..1Reference(US Core Patient Profile)Focus of message
... about 0..*Reference(Resource)Resources that pertain to this communication request
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... payload SI1..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... cdex-payload-query-string S0..1stringExtension
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-query-string
.... cdex-payload-clinical-note-type S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-clinical-note-type
Binding: Clinical Note Type (extensible)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] S1..1string, Attachment, Reference(Resource)Message part content
... occurrence[x] Σ0..1dateTime, PeriodWhen scheduled
... authoredOn Σ0..1dateTimeWhen request transitioned to being actionable
... requester Σ1..1Reference(HRex PractitionerRole | HRex Organization)The person or organization creating the CommunicationRequest
... recipient S1..*Reference(HRex Organization)The recipient(s) of the Communication resulting from this request (not the recipient of the request).
... sender SΣ1..1Reference(HRex Organization)The sender of the Communication resulting from this request (not the sender of the request).
... reasonCode Σ0..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why is communication needed?
... note S0..*AnnotationAdditional human readable info about the request, such as "Requesting discharge summary but if unavailable please send alternative documentation supporting the claim".

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron