STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-communication

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/qicore/StructureDefinition/qicore-communication

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A record of information transmitted from a sender to a receiver
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... communication-reasonNotPerformed I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/communication-reasonNotPerformed
Binding: Communication reason not performed codes (example)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierUnique identifier
... basedOn ∑0..*Reference(Resource)Request fulfilled by this communication
... parent ∑0..*Reference(Resource)Part of this action
... status ?!S0..1codein-progress | completed | suspended | rejected | failed
Binding: CommunicationStatus (required)
... category S0..1CodeableConceptMessage category
Binding: (unbound) (example)
... medium 0..*CodeableConceptA channel of communication
Binding: QICore Communication Medium Codes (example)
... subject S0..1Reference(Profile qicore-patient)Focus of message
... topic ∑0..*Reference(Resource)Focal resources
... context S0..1Reference(Profile qicore-encounter)Encounter or episode leading to message
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... sender S0..1Reference(Profile qicore-practitioner | Profile qicore-patient | Profile qicore-device | Profile qicore-relatedperson | Profile qicore-organization)Message sender
... recipient S0..*Reference(Profile qicore-device | Profile qicore-organization | Profile qicore-patient | Profile qicore-practitioner | Profile qicore-relatedperson | Group)Message recipient
... reason 0..*CodeableConceptIndication for message
Binding: v3 Code System ActReason (example)
... payload ∑0..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... content[x] ∑1..1string, Attachment, Reference(Resource)Message part content
... note ∑0..*AnnotationComments made about the communication

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A record of information transmitted from a sender to a receiver
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... communication-reasonNotPerformed I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/communication-reasonNotPerformed
Binding: Communication reason not performed codes (example)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierUnique identifier
... basedOn ∑0..*Reference(Resource)Request fulfilled by this communication
... parent ∑0..*Reference(Resource)Part of this action
... status ?!S0..1codein-progress | completed | suspended | rejected | failed
Binding: CommunicationStatus (required)
... category S0..1CodeableConceptMessage category
Binding: (unbound) (example)
... medium 0..*CodeableConceptA channel of communication
Binding: QICore Communication Medium Codes (example)
... subject S0..1Reference(Profile qicore-patient)Focus of message
... topic ∑0..*Reference(Resource)Focal resources
... context S0..1Reference(Profile qicore-encounter)Encounter or episode leading to message
... sent S0..1dateTimeWhen sent
... received S0..1dateTimeWhen received
... sender S0..1Reference(Profile qicore-practitioner | Profile qicore-patient | Profile qicore-device | Profile qicore-relatedperson | Profile qicore-organization)Message sender
... recipient S0..*Reference(Profile qicore-device | Profile qicore-organization | Profile qicore-patient | Profile qicore-practitioner | Profile qicore-relatedperson | Group)Message recipient
... reason 0..*CodeableConceptIndication for message
Binding: v3 Code System ActReason (example)
... payload ∑0..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... content[x] ∑1..1string, Attachment, Reference(Resource)Message part content
... note ∑0..*AnnotationComments made about the communication

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Communication.languageCommon LanguagesextensibleCommon Languages
Communication.extension
http://hl7.org/fhir/StructureDefinition/communication-reasonNotPerformed		Communication reason not performed codesexampleCommunication reason not performed codes
Communication.statusCommunicationStatusrequiredCommunicationStatus
Communication.category?extexample
Communication.mediumQICore Communication Medium CodesexampleQICore Communication Medium Codes
Communication.reasonv3 Code System ActReasonexamplev3 Code System ActReason

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CommunicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1CommunicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4CommunicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3CommunicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
ele-1Communication.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Communication.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.