Dental Data Exchange
0.1.0 - STU1 Ballot
Dental Data Exchange
0.1.0 - STU1 Ballot
This page is part of the Dental Data Exchange (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
This profile is used to convey verbal and written communication and education between providers, patients and other members of the care team.
The official URL for this profile is:
http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-communication
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Communication
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
  subject | 0..1 | Reference(US Core Patient Profile) | Focus of message | |
 encounter | 0..1 | Reference(US Core Encounter Profile) | Encounter created as part of | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | I | 0..* | Communication | A record of information transmitted from a sender to a receiver |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Unique identifier |
| instantiatesCanonical | ΣI | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
| instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
| basedOn | ΣI | 0..* | Reference(Resource) | Request fulfilled by this communication |
| partOf | ΣI | 0..* | Reference(Resource) | Part of this action |
| inResponseTo | I | 0..* | Reference(Communication) | Reply to |
| status | ?!ΣI | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
| statusReason | ΣI | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example) |
| category | I | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example) |
| priority | ΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| medium | I | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example) |
| subject | ΣI | 0..1 | Reference(US Core Patient Profile) | Focus of message |
| topic | I | 0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example) |
| about | I | 0..* | Reference(Resource) | Resources that pertain to this communication |
| encounter | ΣI | 0..1 | Reference(US Core Encounter Profile) | Encounter created as part of |
| sent | I | 0..1 | dateTime | When sent |
| received | I | 0..1 | dateTime | When received |
| recipient | I | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
| sender | I | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
| reasonCode | ΣI | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? |
 payload | I | 0..* | BackboneElement | Message payload |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
  content[x] | I | 1..1 | Message part content | |
 contentString | string | |||
| contentAttachment | Attachment | |||
| contentReference | Reference(Resource) | |||
| note | I | 0..* | Annotation | Comments made about the communication |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | I | 0..* | Communication | A record of information transmitted from a sender to a receiver |
| Documentation for this format | ||||
This structure is derived from Communication
Differential View
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
| subject | 0..1 | Reference(US Core Patient Profile) | Focus of message | |
| encounter | 0..1 | Reference(US Core Encounter Profile) | Encounter created as part of | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | I | 0..* | Communication | A record of information transmitted from a sender to a receiver |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Unique identifier |
| instantiatesCanonical | ΣI | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
| instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
| basedOn | ΣI | 0..* | Reference(Resource) | Request fulfilled by this communication |
| partOf | ΣI | 0..* | Reference(Resource) | Part of this action |
| inResponseTo | I | 0..* | Reference(Communication) | Reply to |
| status | ?!ΣI | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
| statusReason | ΣI | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example) |
| category | I | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example) |
| priority | ΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| medium | I | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example) |
| subject | ΣI | 0..1 | Reference(US Core Patient Profile) | Focus of message |
| topic | I | 0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example) |
| about | I | 0..* | Reference(Resource) | Resources that pertain to this communication |
| encounter | ΣI | 0..1 | Reference(US Core Encounter Profile) | Encounter created as part of |
| sent | I | 0..1 | dateTime | When sent |
| received | I | 0..1 | dateTime | When received |
| recipient | I | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
| sender | I | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender |
| reasonCode | ΣI | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? |
| payload | I | 0..* | BackboneElement | Message payload |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| content[x] | I | 1..1 | Message part content | |
| contentString | string | |||
| contentAttachment | Attachment | |||
| contentReference | Reference(Resource) | |||
| note | I | 0..* | Annotation | Comments made about the communication |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| Communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Communication.status | required | EventStatus |
| Communication.statusReason | example | CommunicationNotDoneReason |
| Communication.category | example | CommunicationCategory |
| Communication.priority | required | RequestPriority |
| Communication.medium | example | ParticipationMode |
| Communication.topic | example | CommunicationTopic |
| Communication.reasonCode | example | SNOMEDCTClinicalFindings |
| Id | Path | Details | Requirements |
| dom-2 | Communication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Communication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | Communication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | Communication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Communication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Communication.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Communication.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.inResponseTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.medium | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.topic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.about | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.sent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.received | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.payload.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Communication.payload.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Communication.payload.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Communication.payload.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Communication.payload.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Communication.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ Payer/Provider Information Exchange Work Group. Package hl7.fhir.us.dental-data-exchange#0.1.0 based on FHIR 4.0.1. Generated 2020-08-10
Links: Table of Contents |
QA Report | Search
| Version History |
|
Propose a change