Da Vinci - Coverage Requirements Discovery
1.1.0-ballot - STU 1.1 United States of America flag

Da Vinci - Coverage Requirements Discovery, published by HL7 International - Financial Management Work Group. This is not an authorized publication; it is the continuous build for version 1.1.0-ballot). This version is based on the current content of https://github.com/HL7/davinci-crd/ and changes regularly. See the Directory of published versions

Resource Profile: CommunicationRequest

Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest Version: 1.1.0-ballot
Draft as of 2018-07-25 Computable Name: CommunicationRequest

This profile specifies constraints on the CommunicationRequest resource to support coverage requirements discovery.

Usage


CRD Clients SHALL use this profile to resolve references to CommunicationRequest resources passed to CRD Services (e.g. selections context references) and to populate draftOrders context objects when invoking the when invoking the following CDS Hooks:

Information provided in Must Support elements will commonly be required for CRD Services to perform coverage requirements discovery.

Formal Views of Profile Content

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

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... ext-coverage-information S0..*(Complex)CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
... identifier S0..*IdentifierUnique identifier
... basedOn S1..1Reference(Resource)Fulfills plan or proposal
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Fixed Value: draft
... doNotPerform 0..0
... subject S1..1Reference(Patient)Focus of message
... encounter 0..1Reference(Encounter)Encounter created as part of
... payload S1..*BackboneElementMessage payload
.... extension-CommunicationRequest.payload.content[x] S1..1Attachment, Reference(Resource), CodeableConceptOptional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... value[x] 1..1CodeableConceptValue of extension
... occurrence[x] S0..1dateTime, PeriodWhen scheduled
... authoredOn S1..1dateTimeWhen request transitioned to being actionable
... requester S1..1Reference(Practitioner | US Core PractitionerRole Profile)Who/what is requesting service
... recipient S0..*Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message recipient
... sender S0..1Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message sender
... reasonCode S0..*CodeableConceptWhy is communication needed?
... reasonReference S0..*Reference(US Core Condition Profile | US Core Laboratory Result Observation Profile)Why is communication needed?

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... id Σ0..1stringLogical 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: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-coverage-information S0..*(Complex)CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... basedOn SΣ1..1Reference(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 | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.


Fixed Value: draft
... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes identifying the reason for the current state of a request.

... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.

... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject S1..1Reference(Patient)Focus of message
... about 0..*Reference(Resource)Resources that pertain to this communication request
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... payload S1..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-CommunicationRequest.payload.content[x] S1..1Attachment, Reference(Resource), CodeableConceptExtension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 1..1CodeableConceptValue of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... occurrence[x] SΣ0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn SΣ1..1dateTimeWhen request transitioned to being actionable
... requester SΣ1..1Reference(Practitioner | US Core PractitionerRole Profile)Who/what is requesting service
... recipient S0..*Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message recipient
... sender SΣ0..1Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message sender
... reasonCode SΣ0..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference SΣ0..*Reference(US Core Condition Profile | US Core Laboratory Result Observation Profile)Why is communication needed?
... note 0..*AnnotationComments made about communication request

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... ext-coverage-information 0..*(Complex)CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
... identifier Σ0..*IdentifierUnique identifier
... basedOn Σ1..1Reference(Resource)Fulfills plan or proposal
... subject 1..1Reference(Patient)Focus of message
... payload 1..*BackboneElementMessage payload
.... extension-CommunicationRequest.payload.content[x] 1..1Attachment, Reference(Resource), CodeableConceptExtension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
... occurrence[x] Σ0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn Σ1..1dateTimeWhen request transitioned to being actionable
... requester Σ1..1Reference(Practitioner | US Core PractitionerRole Profile)Who/what is requesting service
... recipient 0..*Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message recipient
... sender Σ0..1Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message sender
... reasonCode Σ0..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference Σ0..*Reference(US Core Condition Profile | US Core Laboratory Result Observation Profile)Why is communication needed?

doco Documentation for this format

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... ext-coverage-information S0..*(Complex)CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
... identifier S0..*IdentifierUnique identifier
... basedOn S1..1Reference(Resource)Fulfills plan or proposal
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Fixed Value: draft
... doNotPerform 0..0
... subject S1..1Reference(Patient)Focus of message
... encounter 0..1Reference(Encounter)Encounter created as part of
... payload S1..*BackboneElementMessage payload
.... extension-CommunicationRequest.payload.content[x] S1..1Attachment, Reference(Resource), CodeableConceptOptional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... value[x] 1..1CodeableConceptValue of extension
... occurrence[x] S0..1dateTime, PeriodWhen scheduled
... authoredOn S1..1dateTimeWhen request transitioned to being actionable
... requester S1..1Reference(Practitioner | US Core PractitionerRole Profile)Who/what is requesting service
... recipient S0..*Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message recipient
... sender S0..1Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message sender
... reasonCode S0..*CodeableConceptWhy is communication needed?
... reasonReference S0..*Reference(US Core Condition Profile | US Core Laboratory Result Observation Profile)Why is communication needed?

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... id Σ0..1stringLogical 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: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-coverage-information S0..*(Complex)CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... basedOn SΣ1..1Reference(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 | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.


Fixed Value: draft
... statusReason 0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes identifying the reason for the current state of a request.

... category 0..*CodeableConceptMessage category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.


... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.

... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... subject S1..1Reference(Patient)Focus of message
... about 0..*Reference(Resource)Resources that pertain to this communication request
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... payload S1..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-CommunicationRequest.payload.content[x] S1..1Attachment, Reference(Resource), CodeableConceptExtension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 1..1CodeableConceptValue of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] 1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... occurrence[x] SΣ0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn SΣ1..1dateTimeWhen request transitioned to being actionable
... requester SΣ1..1Reference(Practitioner | US Core PractitionerRole Profile)Who/what is requesting service
... recipient S0..*Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message recipient
... sender SΣ0..1Reference(Practitioner | US Core PractitionerRole Profile | US Core Organization Profile)Message sender
... reasonCode SΣ0..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference SΣ0..*Reference(US Core Condition Profile | US Core Laboratory Result Observation Profile)Why is communication needed?
... note 0..*AnnotationComments made about communication request

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
CommunicationRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
CommunicationRequest.statusrequiredFixed Value: draft
CommunicationRequest.statusReasonexample
CommunicationRequest.categoryexampleCommunicationCategory
CommunicationRequest.priorityrequiredRequestPriority
CommunicationRequest.mediumexampleParticipationMode
CommunicationRequest.reasonCodeexampleActReason

Constraints

IdGradePathDetailsRequirements
dom-2errorCommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationRequestIf 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-4errorCommunicationRequestIf 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-5errorCommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeCommunicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorCommunicationRequest.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.extension:Coverage-InformationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.extension:Coverage-InformationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.replacesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.groupIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.mediumAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.aboutAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payloadAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload.extension:codeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload.extension:codeableConceptMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload.extension:codeableConcept.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload.extension:codeableConcept.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload.extension:codeableConcept.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.occurrence[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.authoredOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.requesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.recipientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.senderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())