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.3 StructureDefinition-cdex-communication

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

SD.3.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-communication

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

This profile builds on Communication

Summary

Mandatory: 4 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Communication.basedOn is sliced based on the value of profile:reference
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*
... basedOn Reference(Resource)Slice: Unordered, Open by profile:reference
... basedOn S0..*Reference(CDex CommunicationRequest)
... subject S1..1Reference(US Core Patient Profile)
... recipient S1..*Reference(HRex Organization)
... sender S1..1Reference(HRex Organization)
... payload S1..*BackboneElement
.... cdex-payload-query-string S0..1stringAllows determination of which payloads are to satisfy which requests
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-query-string
.... cdex-payload-clinical-note-type S0..1CodeableConceptAllows determination of which payloads are to satisfy which requests
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)
... note S0..*AnnotationAdditional info for the recipient such as "Request was for Discharge Summary but sending Procedure Note instead since patient has not been discharged yet".

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A record of information transmitted from a sender 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
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn ΣReference(Resource)Request fulfilled by this communication
Slice: Unordered, Open by profile:reference
... basedOn SΣ0..*Reference(CDex CommunicationRequest)Request fulfilled by this communication
... partOf Σ0..*Reference(Resource)Part of this action
... inResponseTo 0..*Reference(Communication)Reply to
... status ?!Σ1..1codepreparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... statusReason Σ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example)
... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority Σ0..1codeMessage urgency
Binding: RequestPriority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject SΣ1..1Reference(US Core Patient Profile)Focus of message
... topic 0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example)
... about 0..*Reference(Resource)Resources that pertain to this communication
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... sent 0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... recipient S1..*Reference(HRex Organization)Message recipient
... sender S1..1Reference(HRex Organization)Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... 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..1stringAllows determination of which payloads are to satisfy which requests
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-query-string
.... cdex-payload-clinical-note-type S0..1CodeableConceptAllows determination of which payloads are to satisfy which requests
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
... note S0..*AnnotationAdditional info for the recipient such as "Request was for Discharge Summary but sending Procedure Note instead since patient has not been discharged yet".

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

Summary

Mandatory: 4 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Communication.basedOn is sliced based on the value of profile:reference

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*
... basedOn Reference(Resource)Slice: Unordered, Open by profile:reference
... basedOn S0..*Reference(CDex CommunicationRequest)
... subject S1..1Reference(US Core Patient Profile)
... recipient S1..*Reference(HRex Organization)
... sender S1..1Reference(HRex Organization)
... payload S1..*BackboneElement
.... cdex-payload-query-string S0..1stringAllows determination of which payloads are to satisfy which requests
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-query-string
.... cdex-payload-clinical-note-type S0..1CodeableConceptAllows determination of which payloads are to satisfy which requests
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)
... note S0..*AnnotationAdditional info for the recipient such as "Request was for Discharge Summary but sending Procedure Note instead since patient has not been discharged yet".

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A record of information transmitted from a sender 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
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn ΣReference(Resource)Request fulfilled by this communication
Slice: Unordered, Open by profile:reference
... basedOn SΣ0..*Reference(CDex CommunicationRequest)Request fulfilled by this communication
... partOf Σ0..*Reference(Resource)Part of this action
... inResponseTo 0..*Reference(Communication)Reply to
... status ?!Σ1..1codepreparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... statusReason Σ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example)
... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority Σ0..1codeMessage urgency
Binding: RequestPriority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject SΣ1..1Reference(US Core Patient Profile)Focus of message
... topic 0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example)
... about 0..*Reference(Resource)Resources that pertain to this communication
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... sent 0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... recipient S1..*Reference(HRex Organization)Message recipient
... sender S1..1Reference(HRex Organization)Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... 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..1stringAllows determination of which payloads are to satisfy which requests
URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-payload-query-string
.... cdex-payload-clinical-note-type S0..1CodeableConceptAllows determination of which payloads are to satisfy which requests
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
... note S0..*AnnotationAdditional info for the recipient such as "Request was for Discharge Summary but sending Procedure Note instead since patient has not been discharged yet".

doco Documentation for this format

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