FHIR Clincal Guidelines (v0.1.0) (STU1 Ballot)

This page is part of the Clinical Guidelines (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

D.4.1 StructureDefinition: cpg-communicationrequest

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest

Profile of CommunicationRequest for use with CPG Implementation Guide

This profile builds on CommunicationRequest.

This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*A request for information to be sent 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-instantiatesCanonical SI0..*canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)FHIR protocol or definition
URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical
... cqf-strengthOfRecommendation SI0..*CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
... cqf-qualityOfEvidence SI0..*CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierUnique identifier
... basedOn Σ0..*Reference(Resource)Fulfills plan or proposal
... replaces Σ0..*Reference(CommunicationRequest)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority SΣ0..1codeMessage urgency
Binding: RequestPriority (required)
... doNotPerform ?!SΣ0..1booleanTrue if request is prohibiting action
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject S0..1Reference(Patient | Group)Focus of message
... about S0..*Reference(Resource)Resources that pertain to this communication request
... encounter SΣ0..1Reference(Encounter)Encounter created as part of
... payload I0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(http://hl7.org/fhir/R4/resource.html)
... occurrence[x] Σ0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn Σ0..1dateTimeWhen request transitioned to being actionable
... requester SΣ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender SΣ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode Σ0..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why is communication needed?
... note 0..*AnnotationComments made about communication request

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*A request for information to be sent 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-instantiatesCanonical SI0..*canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)FHIR protocol or definition
URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical
... cqf-strengthOfRecommendation SI0..*CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
... cqf-qualityOfEvidence SI0..*CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierUnique identifier
... basedOn Σ0..*Reference(Resource)Fulfills plan or proposal
... replaces Σ0..*Reference(CommunicationRequest)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example)
... category S0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority SΣ0..1codeMessage urgency
Binding: RequestPriority (required)
... doNotPerform ?!SΣ0..1booleanTrue if request is prohibiting action
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject S0..1Reference(Patient | Group)Focus of message
... about S0..*Reference(Resource)Resources that pertain to this communication request
... encounter SΣ0..1Reference(Encounter)Encounter created as part of
... payload I0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(http://hl7.org/fhir/R4/resource.html)
... occurrence[x] Σ0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn Σ0..1dateTimeWhen request transitioned to being actionable
... requester SΣ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender SΣ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode Σ0..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why is communication needed?
... note 0..*AnnotationComments made about communication request

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
CommunicationRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
CommunicationRequest.statusrequiredRequestStatus
CommunicationRequest.statusReasonexample
CommunicationRequest.categoryexampleCommunicationCategory
CommunicationRequest.priorityrequiredRequestPriority
CommunicationRequest.mediumexamplev3.ParticipationMode
CommunicationRequest.reasonCodeexamplev3.ActReason

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4CommunicationRequestIf 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-3CommunicationRequestIf 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-6CommunicationRequestA resource should have narrative for robust management
: text.div.exists()
dom-5CommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1CommunicationRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CommunicationRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CommunicationRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CommunicationRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CommunicationRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CommunicationRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CommunicationRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CommunicationRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CommunicationRequest.payloadAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())