This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.2.0-ballot: STU 2.2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.1.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest | Version: 2.2.0-ballot | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: CRDCommunicationRequest | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.18.42.6 |
This profile specifies constraints on the CommunicationRequest resource to support coverage requirements discovery.
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.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | CoverageInfo URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information Constraints: crd-ci-q1, crd-ci-q2, crd-ci-q3, crd-ci-q4, crd-ci-q5, crd-ci-q6, crd-ci-q7, crd-ci-q8 |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Unique identifier |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Resource) | Fulfills plan or proposal |
![]() ![]() ![]() |
Σ | 0..* | Reference(CRD Communication Request) | Request(s) replaced by this request |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. Example General: draft |
![]() ![]() ![]() |
S | 1..1 | Reference(CRD Patient) | Focus of message |
![]() ![]() ![]() |
Σ | 0..1 | Reference(CRD Encounter) | Encounter created as part of |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Message payload |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content%5Bx%5D |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Expected Billing Code(s) URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-billing-options Binding: CRD Billing Codes Value Set (extensible) |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() |
SΣ | 0..1 | When scheduled | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When request transitioned to being actionable |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S) | Who/what is requesting service |
![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S | CRD Organization S) | Message recipient |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S | CRD Organization S) | Message sender |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. |
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) | US Core Condition Encounter Diagnosis Profile(7.0.0) | US Core DiagnosticReport Profile for Laboratory Results Reporting(7.0.0) | US Core DiagnosticReport Profile for Report and Note Exchange(7.0.0) | US Core DocumentReference Profile(7.0.0) | Observation) | Why is communication needed? |
![]() |
Path | Conformance | ValueSet | URI |
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | |
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason|3.0.0 |
Id | Grade | Path(s) | Details | Requirements |
crd-ci-q1 | error | CommunicationRequest.extension:Coverage-Information | Questionnaire is only allowed when doc-needed exists : extension.where(url='questionnaire').exists() implies extension.where(url = 'doc-needed').exists() | |
crd-ci-q2 | error | CommunicationRequest.extension:Coverage-Information | If covered is set to 'not-covered', then 'pa-needed' must not exist. : extension.where(url = 'covered' and value = 'not-covered').exists() implies extension.where(url = 'pa-needed').exists().not() | |
crd-ci-q3 | error | CommunicationRequest.extension:Coverage-Information | 'info-needed' SHALL exist if and only if at least one of 'covered', 'pa-needed', or 'doc-needed' is set to 'conditional'. : extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 implies extension.where(url = 'info-needed').exists() | |
crd-ci-q4 | error | CommunicationRequest.extension:Coverage-Information | If 'pa-needed' is 'satisfied', 'noauth', or 'not-covered', then 'Doc-purpose' can't be 'withpa'. : extension.where(url = 'pa-needed' and (value = 'satisfied' or value = 'noauth' or value = 'not-covered')) and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'withpa') | |
crd-ci-q5 | error | CommunicationRequest.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() | |
crd-ci-q6 | error | CommunicationRequest.extension:Coverage-Information | If 'info-needed' is OTH, then reason must be specified : extension.where(url = 'info-needed' and value = 'OTH').exists() implies extension.where(url = 'reason').exists() | |
crd-ci-q7 | error | CommunicationRequest.extension:Coverage-Information | If reason.coding is present and is not from the extensible value set, then reason.text must be present : extension.where(url = 'reason').empty() or extension.where(url = 'reason').value.text.exists() or extension.where(url = 'reason').value.memberOf('http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageAssertionReasons') | |
crd-ci-q8 | error | CommunicationRequest.extension:Coverage-Information | If doc-purpose is present with a value other than 'conditional', then reason must be present : extension.where(url = 'doc-purpose' and value != 'conditional').exists() implies extension.where(url = 'reason').exists() | |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If 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-4 | error | CommunicationRequest | If 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-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CommunicationRequest
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | CoverageInfo URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information Constraints: crd-ci-q1, crd-ci-q2, crd-ci-q3, crd-ci-q4, crd-ci-q5, crd-ci-q6, crd-ci-q7, crd-ci-q8 | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Resource) | Fulfills plan or proposal | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CRD Communication Request) | Request(s) replaced by this request | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. Example General: draft | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (3.0.0) (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() ![]() |
S | 1..1 | Reference(CRD Patient) | Focus of message | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(CRD Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Message payload | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content%5Bx%5D | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Expected Billing Code(s) URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-billing-options Binding: CRD Billing Codes Value Set (extensible) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() |
SΣ | 0..1 | When scheduled | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When request transitioned to being actionable | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S) | Who/what is requesting service | ||||
![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S | CRD Organization S) | Message recipient | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S | CRD Organization S) | Message sender | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) | US Core Condition Encounter Diagnosis Profile(7.0.0) | US Core DiagnosticReport Profile for Laboratory Results Reporting(7.0.0) | US Core DiagnosticReport Profile for Report and Note Exchange(7.0.0) | US Core DocumentReference Profile(7.0.0) | Observation) | Why is communication needed? | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about communication request | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
CommunicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.statusReason | example | |||||
CommunicationRequest.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category From the FHIR Standard | ||||
CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode|3.0.0 | ||||
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason|3.0.0 |
Id | Grade | Path(s) | Details | Requirements |
crd-ci-q1 | error | CommunicationRequest.extension:Coverage-Information | Questionnaire is only allowed when doc-needed exists : extension.where(url='questionnaire').exists() implies extension.where(url = 'doc-needed').exists() | |
crd-ci-q2 | error | CommunicationRequest.extension:Coverage-Information | If covered is set to 'not-covered', then 'pa-needed' must not exist. : extension.where(url = 'covered' and value = 'not-covered').exists() implies extension.where(url = 'pa-needed').exists().not() | |
crd-ci-q3 | error | CommunicationRequest.extension:Coverage-Information | 'info-needed' SHALL exist if and only if at least one of 'covered', 'pa-needed', or 'doc-needed' is set to 'conditional'. : extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 implies extension.where(url = 'info-needed').exists() | |
crd-ci-q4 | error | CommunicationRequest.extension:Coverage-Information | If 'pa-needed' is 'satisfied', 'noauth', or 'not-covered', then 'Doc-purpose' can't be 'withpa'. : extension.where(url = 'pa-needed' and (value = 'satisfied' or value = 'noauth' or value = 'not-covered')) and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'withpa') | |
crd-ci-q5 | error | CommunicationRequest.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() | |
crd-ci-q6 | error | CommunicationRequest.extension:Coverage-Information | If 'info-needed' is OTH, then reason must be specified : extension.where(url = 'info-needed' and value = 'OTH').exists() implies extension.where(url = 'reason').exists() | |
crd-ci-q7 | error | CommunicationRequest.extension:Coverage-Information | If reason.coding is present and is not from the extensible value set, then reason.text must be present : extension.where(url = 'reason').empty() or extension.where(url = 'reason').value.text.exists() or extension.where(url = 'reason').value.memberOf('http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageAssertionReasons') | |
crd-ci-q8 | error | CommunicationRequest.extension:Coverage-Information | If doc-purpose is present with a value other than 'conditional', then reason must be present : extension.where(url = 'doc-purpose' and value != 'conditional').exists() implies extension.where(url = 'reason').exists() | |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If 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-4 | error | CommunicationRequest | If 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-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CommunicationRequest
Summary
Mandatory: 7 elements
Must-Support: 15 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | CoverageInfo URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information Constraints: crd-ci-q1, crd-ci-q2, crd-ci-q3, crd-ci-q4, crd-ci-q5, crd-ci-q6, crd-ci-q7, crd-ci-q8 |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Unique identifier |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Resource) | Fulfills plan or proposal |
![]() ![]() ![]() |
Σ | 0..* | Reference(CRD Communication Request) | Request(s) replaced by this request |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. Example General: draft |
![]() ![]() ![]() |
S | 1..1 | Reference(CRD Patient) | Focus of message |
![]() ![]() ![]() |
Σ | 0..1 | Reference(CRD Encounter) | Encounter created as part of |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Message payload |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content%5Bx%5D |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Expected Billing Code(s) URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-billing-options Binding: CRD Billing Codes Value Set (extensible) |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() |
SΣ | 0..1 | When scheduled | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When request transitioned to being actionable |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S) | Who/what is requesting service |
![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S | CRD Organization S) | Message recipient |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S | CRD Organization S) | Message sender |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. |
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) | US Core Condition Encounter Diagnosis Profile(7.0.0) | US Core DiagnosticReport Profile for Laboratory Results Reporting(7.0.0) | US Core DiagnosticReport Profile for Report and Note Exchange(7.0.0) | US Core DocumentReference Profile(7.0.0) | Observation) | Why is communication needed? |
![]() |
Path | Conformance | ValueSet | URI |
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | |
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason|3.0.0 |
Id | Grade | Path(s) | Details | Requirements |
crd-ci-q1 | error | CommunicationRequest.extension:Coverage-Information | Questionnaire is only allowed when doc-needed exists : extension.where(url='questionnaire').exists() implies extension.where(url = 'doc-needed').exists() | |
crd-ci-q2 | error | CommunicationRequest.extension:Coverage-Information | If covered is set to 'not-covered', then 'pa-needed' must not exist. : extension.where(url = 'covered' and value = 'not-covered').exists() implies extension.where(url = 'pa-needed').exists().not() | |
crd-ci-q3 | error | CommunicationRequest.extension:Coverage-Information | 'info-needed' SHALL exist if and only if at least one of 'covered', 'pa-needed', or 'doc-needed' is set to 'conditional'. : extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 implies extension.where(url = 'info-needed').exists() | |
crd-ci-q4 | error | CommunicationRequest.extension:Coverage-Information | If 'pa-needed' is 'satisfied', 'noauth', or 'not-covered', then 'Doc-purpose' can't be 'withpa'. : extension.where(url = 'pa-needed' and (value = 'satisfied' or value = 'noauth' or value = 'not-covered')) and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'withpa') | |
crd-ci-q5 | error | CommunicationRequest.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() | |
crd-ci-q6 | error | CommunicationRequest.extension:Coverage-Information | If 'info-needed' is OTH, then reason must be specified : extension.where(url = 'info-needed' and value = 'OTH').exists() implies extension.where(url = 'reason').exists() | |
crd-ci-q7 | error | CommunicationRequest.extension:Coverage-Information | If reason.coding is present and is not from the extensible value set, then reason.text must be present : extension.where(url = 'reason').empty() or extension.where(url = 'reason').value.text.exists() or extension.where(url = 'reason').value.memberOf('http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageAssertionReasons') | |
crd-ci-q8 | error | CommunicationRequest.extension:Coverage-Information | If doc-purpose is present with a value other than 'conditional', then reason must be present : extension.where(url = 'doc-purpose' and value != 'conditional').exists() implies extension.where(url = 'reason').exists() | |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If 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-4 | error | CommunicationRequest | If 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-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from CommunicationRequest
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | CoverageInfo URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information Constraints: crd-ci-q1, crd-ci-q2, crd-ci-q3, crd-ci-q4, crd-ci-q5, crd-ci-q6, crd-ci-q7, crd-ci-q8 | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Resource) | Fulfills plan or proposal | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CRD Communication Request) | Request(s) replaced by this request | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. Example General: draft | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (3.0.0) (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() ![]() |
S | 1..1 | Reference(CRD Patient) | Focus of message | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(CRD Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Message payload | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content%5Bx%5D | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content[x]" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Expected Billing Code(s) URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-billing-options Binding: CRD Billing Codes Value Set (extensible) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() |
SΣ | 0..1 | When scheduled | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When request transitioned to being actionable | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S) | Who/what is requesting service | ||||
![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S | CRD Organization S) | Message recipient | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | HRex PractitionerRole Profile S | CRD Organization S) | Message sender | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) | US Core Condition Encounter Diagnosis Profile(7.0.0) | US Core DiagnosticReport Profile for Laboratory Results Reporting(7.0.0) | US Core DiagnosticReport Profile for Report and Note Exchange(7.0.0) | US Core DocumentReference Profile(7.0.0) | Observation) | Why is communication needed? | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about communication request | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
CommunicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.statusReason | example | |||||
CommunicationRequest.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category From the FHIR Standard | ||||
CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode|3.0.0 | ||||
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason|3.0.0 |
Id | Grade | Path(s) | Details | Requirements |
crd-ci-q1 | error | CommunicationRequest.extension:Coverage-Information | Questionnaire is only allowed when doc-needed exists : extension.where(url='questionnaire').exists() implies extension.where(url = 'doc-needed').exists() | |
crd-ci-q2 | error | CommunicationRequest.extension:Coverage-Information | If covered is set to 'not-covered', then 'pa-needed' must not exist. : extension.where(url = 'covered' and value = 'not-covered').exists() implies extension.where(url = 'pa-needed').exists().not() | |
crd-ci-q3 | error | CommunicationRequest.extension:Coverage-Information | 'info-needed' SHALL exist if and only if at least one of 'covered', 'pa-needed', or 'doc-needed' is set to 'conditional'. : extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 implies extension.where(url = 'info-needed').exists() | |
crd-ci-q4 | error | CommunicationRequest.extension:Coverage-Information | If 'pa-needed' is 'satisfied', 'noauth', or 'not-covered', then 'Doc-purpose' can't be 'withpa'. : extension.where(url = 'pa-needed' and (value = 'satisfied' or value = 'noauth' or value = 'not-covered')) and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'withpa') | |
crd-ci-q5 | error | CommunicationRequest.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() | |
crd-ci-q6 | error | CommunicationRequest.extension:Coverage-Information | If 'info-needed' is OTH, then reason must be specified : extension.where(url = 'info-needed' and value = 'OTH').exists() implies extension.where(url = 'reason').exists() | |
crd-ci-q7 | error | CommunicationRequest.extension:Coverage-Information | If reason.coding is present and is not from the extensible value set, then reason.text must be present : extension.where(url = 'reason').empty() or extension.where(url = 'reason').value.text.exists() or extension.where(url = 'reason').value.memberOf('http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageAssertionReasons') | |
crd-ci-q8 | error | CommunicationRequest.extension:Coverage-Information | If doc-purpose is present with a value other than 'conditional', then reason must be present : extension.where(url = 'doc-purpose' and value != 'conditional').exists() implies extension.where(url = 'reason').exists() | |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If 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-4 | error | CommunicationRequest | If 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-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CommunicationRequest
Summary
Mandatory: 7 elements
Must-Support: 15 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron