Da Vinci - Coverage Requirements Discovery
2.1.0-preview - STU 2 United States of America flag

Da Vinci - Coverage Requirements Discovery, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. 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: CRD Communication Request

Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest Version: 2.1.0-preview
Standards status: Trial-use Maturity Level: 1 Computable Name: CRDCommunicationRequest

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 Servers (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 Servers to perform coverage requirements discovery.

Usage:

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..* CommunicationRequest A request for information to be sent to a receiver
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... Coverage-Information S 0..* (Complex) CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
... identifier S 0..* Identifier Unique identifier
... replaces 0..* Reference(CRD Communication Request) Request(s) replaced by this request
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Fixed Value: draft
... doNotPerform 0..0
... subject S 1..1 Reference(CRD Patient) Focus of message
... encounter 0..1 Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) Encounter created as part of
... payload S 1..* BackboneElement Message payload
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... codeableConcept S 1..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... value[x] 1..1 CodeableConcept Value of extension
... occurrence[x] S 0..1 dateTime, Period When scheduled
... authoredOn S 1..1 dateTime When request transitioned to being actionable
... requester S 1..1 Reference(CRD Practitioner | HRex PractitionerRole Profile) Who/what is requesting service
... recipient S 0..* Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message recipient
... sender S 0..1 Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message sender
... reasonCode S 0..* CodeableConcept Why is communication needed?
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... Coverage-Information SC 0..* (Complex) CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
crd-ci-q1: Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc'
crd-ci-q2: If covered is set to 'not-covered', then 'pa-needed' should not exist.
crd-ci-q3: If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'.
crd-ci-q4: If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'.
crd-ci-q5: 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'.
... identifier SΣ 0..* Identifier Unique identifier
... basedOn SΣ 1..1 Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CRD Communication Request) Request(s) replaced by this request
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.


Fixed Value: draft
... subject S 1..1 Reference(CRD Patient) Focus of message
... encounter Σ 0..1 Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) Encounter created as part of
... payload S 1..* BackboneElement Message payload
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... codeableConcept S 1..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]"
..... value[x] 1..1 CodeableConcept Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] 1..1 Message part content
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... occurrence[x] SΣ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn SΣ 1..1 dateTime When request transitioned to being actionable
... requester SΣ 1..1 Reference(CRD Practitioner | HRex PractitionerRole Profile) Who/what is requesting service
... recipient S 0..* Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message recipient
... sender SΣ 0..1 Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message sender
... reasonCode SΣ 0..* CodeableConcept Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference SΣ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CommunicationRequest.statusrequiredFixed Value: draft
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CommunicationRequest.reasonCodeexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
crd-ci-q1errorCommunicationRequest.extension:Coverage-InformationQuestionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc'
: extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc'))
crd-ci-q2errorCommunicationRequest.extension:Coverage-InformationIf covered is set to 'not-covered', then 'pa-needed' should not exist.
: extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists()
crd-ci-q3errorCommunicationRequest.extension:Coverage-InformationIf 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'.
: extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1
crd-ci-q4errorCommunicationRequest.extension:Coverage-InformationIf 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'.
: extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA')
crd-ci-q5errorCommunicationRequest.extension:Coverage-Information'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'.
: extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists()
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... Coverage-Information SC 0..* (Complex) CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
crd-ci-q1: Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc'
crd-ci-q2: If covered is set to 'not-covered', then 'pa-needed' should not exist.
crd-ci-q3: If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'.
crd-ci-q4: If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'.
crd-ci-q5: 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier
... basedOn SΣ 1..1 Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CRD Communication Request) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.


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

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


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

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


... subject S 1..1 Reference(CRD Patient) Focus of message
... about 0..* Reference(Resource) Resources that pertain to this communication request
... encounter Σ 0..1 Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) Encounter created as part of
... payload S 1..* BackboneElement Message payload
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... codeableConcept S 1..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]"
..... value[x] 1..1 CodeableConcept Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] 1..1 Message part content
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... occurrence[x] SΣ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn SΣ 1..1 dateTime When request transitioned to being actionable
... requester SΣ 1..1 Reference(CRD Practitioner | HRex PractitionerRole Profile) Who/what is requesting service
... recipient S 0..* Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message recipient
... sender SΣ 0..1 Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message sender
... reasonCode SΣ 0..* CodeableConcept Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference SΣ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CommunicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CommunicationRequest.statusrequiredFixed Value: draft
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CommunicationRequest.statusReasonexample
CommunicationRequest.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
CommunicationRequest.mediumexampleParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.reasonCodeexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
crd-ci-q1errorCommunicationRequest.extension:Coverage-InformationQuestionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc'
: extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc'))
crd-ci-q2errorCommunicationRequest.extension:Coverage-InformationIf covered is set to 'not-covered', then 'pa-needed' should not exist.
: extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists()
crd-ci-q3errorCommunicationRequest.extension:Coverage-InformationIf 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'.
: extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1
crd-ci-q4errorCommunicationRequest.extension:Coverage-InformationIf 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'.
: extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA')
crd-ci-q5errorCommunicationRequest.extension:Coverage-Information'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'.
: extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists()
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... Coverage-Information S 0..* (Complex) CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
... identifier S 0..* Identifier Unique identifier
... replaces 0..* Reference(CRD Communication Request) Request(s) replaced by this request
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Fixed Value: draft
... doNotPerform 0..0
... subject S 1..1 Reference(CRD Patient) Focus of message
... encounter 0..1 Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) Encounter created as part of
... payload S 1..* BackboneElement Message payload
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... codeableConcept S 1..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... value[x] 1..1 CodeableConcept Value of extension
... occurrence[x] S 0..1 dateTime, Period When scheduled
... authoredOn S 1..1 dateTime When request transitioned to being actionable
... requester S 1..1 Reference(CRD Practitioner | HRex PractitionerRole Profile) Who/what is requesting service
... recipient S 0..* Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message recipient
... sender S 0..1 Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message sender
... reasonCode S 0..* CodeableConcept Why is communication needed?
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... Coverage-Information SC 0..* (Complex) CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
crd-ci-q1: Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc'
crd-ci-q2: If covered is set to 'not-covered', then 'pa-needed' should not exist.
crd-ci-q3: If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'.
crd-ci-q4: If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'.
crd-ci-q5: 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'.
... identifier SΣ 0..* Identifier Unique identifier
... basedOn SΣ 1..1 Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CRD Communication Request) Request(s) replaced by this request
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.


Fixed Value: draft
... subject S 1..1 Reference(CRD Patient) Focus of message
... encounter Σ 0..1 Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) Encounter created as part of
... payload S 1..* BackboneElement Message payload
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... codeableConcept S 1..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]"
..... value[x] 1..1 CodeableConcept Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] 1..1 Message part content
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... occurrence[x] SΣ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn SΣ 1..1 dateTime When request transitioned to being actionable
... requester SΣ 1..1 Reference(CRD Practitioner | HRex PractitionerRole Profile) Who/what is requesting service
... recipient S 0..* Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message recipient
... sender SΣ 0..1 Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message sender
... reasonCode SΣ 0..* CodeableConcept Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference SΣ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CommunicationRequest.statusrequiredFixed Value: draft
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CommunicationRequest.reasonCodeexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
crd-ci-q1errorCommunicationRequest.extension:Coverage-InformationQuestionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc'
: extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc'))
crd-ci-q2errorCommunicationRequest.extension:Coverage-InformationIf covered is set to 'not-covered', then 'pa-needed' should not exist.
: extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists()
crd-ci-q3errorCommunicationRequest.extension:Coverage-InformationIf 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'.
: extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1
crd-ci-q4errorCommunicationRequest.extension:Coverage-InformationIf 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'.
: extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA')
crd-ci-q5errorCommunicationRequest.extension:Coverage-Information'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'.
: extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists()
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... Coverage-Information SC 0..* (Complex) CoverageInfo
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information
crd-ci-q1: Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc'
crd-ci-q2: If covered is set to 'not-covered', then 'pa-needed' should not exist.
crd-ci-q3: If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'.
crd-ci-q4: If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'.
crd-ci-q5: 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'.
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique identifier
... basedOn SΣ 1..1 Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CRD Communication Request) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.


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

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


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

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


... subject S 1..1 Reference(CRD Patient) Focus of message
... about 0..* Reference(Resource) Resources that pertain to this communication request
... encounter Σ 0..1 Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) Encounter created as part of
... payload S 1..* BackboneElement Message payload
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... codeableConcept S 1..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]"
..... value[x] 1..1 CodeableConcept Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] 1..1 Message part content
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... occurrence[x] SΣ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn SΣ 1..1 dateTime When request transitioned to being actionable
... requester SΣ 1..1 Reference(CRD Practitioner | HRex PractitionerRole Profile) Who/what is requesting service
... recipient S 0..* Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message recipient
... sender SΣ 0..1 Reference(CRD Practitioner | HRex PractitionerRole Profile | CRD Organization) Message sender
... reasonCode SΣ 0..* CodeableConcept Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.


... reasonReference SΣ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CommunicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CommunicationRequest.statusrequiredFixed Value: draft
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CommunicationRequest.statusReasonexample
CommunicationRequest.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
from the FHIR Standard
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
CommunicationRequest.mediumexampleParticipationMode
http://terminology.hl7.org/ValueSet/v3-ParticipationMode
CommunicationRequest.reasonCodeexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
crd-ci-q1errorCommunicationRequest.extension:Coverage-InformationQuestionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc'
: extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc'))
crd-ci-q2errorCommunicationRequest.extension:Coverage-InformationIf covered is set to 'not-covered', then 'pa-needed' should not exist.
: extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists()
crd-ci-q3errorCommunicationRequest.extension:Coverage-InformationIf 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'.
: extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1
crd-ci-q4errorCommunicationRequest.extension:Coverage-InformationIf 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'.
: extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA')
crd-ci-q5errorCommunicationRequest.extension:Coverage-Information'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'.
: extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists()
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron