QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)

QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions

D.4.1 StructureDefinition-qicore-communicationnotdone

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

Negation Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communicationnotdone

Profile of CommunicationNotDone for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile builds on Communication.

This profile was published on Wed Aug 22 00:00:00 UTC 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 7 elements
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qicore-recorded SI1..1dateTimeExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded
... modifierExtension ?!I0..*(Slice Definition)Extension
Slice: Unordered, Open by value:url
... modifierExtension:notDone ?!SI1..1QICoreNotDoneExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDone"
.... value[x] SI1..1booleanValue of extension
Fixed Value: true
... identifier ΣI0..*IdentifierUnique identifier
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(Resource)Request fulfilled by this communication
... partOf ΣI0..*Reference(Resource)Part of this action
... inResponseTo I0..*Reference(Communication)Reply to
... status ?!SΣI1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
Fixed Value: not-done
... statusReason SΣI1..1CodeableConceptReason for current status
Binding: Negation Reason Codes (extensible)
... category I0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... medium I0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject ΣI0..1Reference(Patient | Group)Focus of message
... topic I0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example)
... about I0..*Reference(Resource)Resources that pertain to this communication
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... sent I0..1dateTimeWhen sent
... received I0..1dateTimeWhen received
... recipient I0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender I0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode SΣI0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... valueset-reference SI1..1uriUrl of Value set the code was chosen from
URL: http://hl7.org/fhir/StructureDefinition/valueset-reference
..... system ΣI0..1uriIdentity of the terminology system
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI0..1codeSymbol in syntax defined by the system
..... display ΣI0..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... payload I0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] I1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... note I0..*AnnotationComments made about the communication

doco Documentation for this format

Summary

Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 7 elements
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qicore-recorded SI1..1dateTimeExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded
... modifierExtension ?!I0..*(Slice Definition)Extension
Slice: Unordered, Open by value:url
... modifierExtension:notDone ?!SI1..1QICoreNotDoneExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDone"
.... value[x] SI1..1booleanValue of extension
Fixed Value: true
... identifier ΣI0..*IdentifierUnique identifier
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(Resource)Request fulfilled by this communication
... partOf ΣI0..*Reference(Resource)Part of this action
... inResponseTo I0..*Reference(Communication)Reply to
... status ?!SΣI1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
Fixed Value: not-done
... statusReason SΣI1..1CodeableConceptReason for current status
Binding: Negation Reason Codes (extensible)
... category I0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... medium I0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject ΣI0..1Reference(Patient | Group)Focus of message
... topic I0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example)
... about I0..*Reference(Resource)Resources that pertain to this communication
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... sent I0..1dateTimeWhen sent
... received I0..1dateTimeWhen received
... recipient I0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender I0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode SΣI0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... valueset-reference SI1..1uriUrl of Value set the code was chosen from
URL: http://hl7.org/fhir/StructureDefinition/valueset-reference
..... system ΣI0..1uriIdentity of the terminology system
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI0..1codeSymbol in syntax defined by the system
..... display ΣI0..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... payload I0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] I1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... note I0..*AnnotationComments made about the communication

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Communication.statusrequiredFixed Value: not-done
Communication.statusReasonextensibleNegationReasonCodes
Communication.categoryexampleCommunicationCategory
Communication.priorityrequiredRequestPriority
Communication.mediumexamplev3.ParticipationMode
Communication.topicexampleCommunicationTopic
Communication.reasonCodeexampleSNOMEDCTClinicalFindings

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3CommunicationIf 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-4CommunicationIf 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-5CommunicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6CommunicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1Communication.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.extension:recordedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.extension:recordedMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.modifierExtension:notDoneAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.modifierExtension:notDoneMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.modifierExtension:notDone.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.modifierExtension:notDone.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.modifierExtension:notDone.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.inResponseToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.mediumAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.aboutAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.sentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.receivedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.recipientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.senderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCode.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.reasonCode.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.reasonCode.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCode.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.reasonCode.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.reasonCode.coding.extension:notDoneValueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.reasonCode.coding.extension:notDoneValueSetMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.reasonCode.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCode.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCode.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCode.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCode.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonCode.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.payloadAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.payload.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.payload.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.payload.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Communication.payload.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Communication.payload.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Communication.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())