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-communicationrequest

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

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

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
.. CommunicationRequest I0..*A request for information to be sent 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
... communicationrequest-reasonRejected I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/communicationrequest-reasonRejected
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
... category S0..1CodeableConceptMessage category
Binding: (unbound) (example)
... 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-practitioner | Profile qicore-patient | Profile qicore-device | Profile qicore-relatedperson | Profile qicore-organization)Message recipient
... 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
... medium 0..*CodeableConceptA channel of communication
Binding: QICore Communication Medium Codes (example)
... requester 0..1Reference(Profile qicore-patient | Profile qicore-practitioner | Profile qicore-relatedperson)An individual who requested a communication
... status ?!S0..1codeproposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed
Binding: CommunicationRequestStatus (required)
... encounter S0..1Reference(Profile qicore-encounter)Encounter leading to message
... scheduled[x] 0..1dateTime, PeriodWhen scheduled
... reason 0..*CodeableConceptIndication for message
Binding: v3 Code System ActReason (example)
... requestedOn S0..1dateTimeWhen ordered or proposed
... subject S0..1Reference(Patient)Focus of message
... priority 0..1CodeableConceptMessage urgency
Binding: RequestPriority (example)

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*A request for information to be sent 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
... communicationrequest-reasonRejected I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/communicationrequest-reasonRejected
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
... category S0..1CodeableConceptMessage category
Binding: (unbound) (example)
... 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-practitioner | Profile qicore-patient | Profile qicore-device | Profile qicore-relatedperson | Profile qicore-organization)Message recipient
... 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
... medium 0..*CodeableConceptA channel of communication
Binding: QICore Communication Medium Codes (example)
... requester 0..1Reference(Profile qicore-patient | Profile qicore-practitioner | Profile qicore-relatedperson)An individual who requested a communication
... status ?!S0..1codeproposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed
Binding: CommunicationRequestStatus (required)
... encounter S0..1Reference(Profile qicore-encounter)Encounter leading to message
... scheduled[x] 0..1dateTime, PeriodWhen scheduled
... reason 0..*CodeableConceptIndication for message
Binding: v3 Code System ActReason (example)
... requestedOn S0..1dateTimeWhen ordered or proposed
... subject S0..1Reference(Patient)Focus of message
... priority 0..1CodeableConceptMessage urgency
Binding: RequestPriority (example)

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
CommunicationRequest.languageCommon LanguagesextensibleCommon Languages
CommunicationRequest.extension
http://hl7.org/fhir/StructureDefinition/communicationrequest-reasonRejected
Communication reason not performed codesexampleCommunication reason not performed codes
CommunicationRequest.category?extexample
CommunicationRequest.mediumQICore Communication Medium CodesexampleQICore Communication Medium Codes
CommunicationRequest.statusCommunicationRequestStatusrequiredCommunicationRequestStatus
CommunicationRequest.reasonv3 Code System ActReasonexamplev3 Code System ActReason
CommunicationRequest.priorityRequestPriorityexampleRequestPriority

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1CommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4CommunicationRequestIf 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-3CommunicationRequestIf 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-1CommunicationRequest.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1CommunicationRequest.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.