Da Vinci - Coverage Requirements Discovery
2.0.1 - STU 2
Da Vinci - Coverage Requirements Discovery
2.0.1 - STU 2
This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.0.1: STU 2.0) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). 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.0.1 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: CommunicationRequest | ||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 |
 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 |
| 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) | 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 | CodeableConcept | 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 | US Core PractitionerRole Profile) | Who/what is requesting service |
| recipient | S | 0..* | Reference(CRD Practitioner | US Core PractitionerRole Profile | US Core Organization Profile) | Message recipient |
| sender | SΣ | 0..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile | US Core Organization Profile) | 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(US Core Condition Profile | US Core Laboratory Result Observation Profile) | Why is communication needed? |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| CommunicationRequest.status | required | Fixed Value: draft |
| CommunicationRequest.reasonCode | example | ActReason |
| Id | Grade | Path(s) | Details | Requirements |
| crd-ci-q1 | error | CommunicationRequest.extension:Coverage-Information | Questionnaire 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-q2 | error | CommunicationRequest.extension:Coverage-Information | If 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-q3 | error | CommunicationRequest.extension:Coverage-Information | If '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-q4 | error | CommunicationRequest.extension:Coverage-Information | If '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-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() | |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | ||||
| 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) | 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 | CodeableConcept | 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 | US Core PractitionerRole Profile) | Who/what is requesting service | ||||
| recipient | S | 0..* | Reference(CRD Practitioner | US Core PractitionerRole Profile | US Core Organization Profile) | Message recipient | ||||
| sender | SΣ | 0..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile | US Core Organization Profile) | 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(US Core Condition Profile | US Core Laboratory Result Observation Profile) | Why is communication needed? | ||||
| note | 0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| CommunicationRequest.language | preferred | CommonLanguages
| ||||
| CommunicationRequest.status | required | Fixed Value: draft | ||||
| CommunicationRequest.statusReason | example | |||||
| CommunicationRequest.category | example | CommunicationCategory | ||||
| CommunicationRequest.priority | required | RequestPriority | ||||
| CommunicationRequest.medium | example | ParticipationMode | ||||
| CommunicationRequest.reasonCode | example | ActReason |
| Id | Grade | Path(s) | Details | Requirements |
| crd-ci-q1 | error | CommunicationRequest.extension:Coverage-Information | Questionnaire 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-q2 | error | CommunicationRequest.extension:Coverage-Information | If 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-q3 | error | CommunicationRequest.extension:Coverage-Information | If '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-q4 | error | CommunicationRequest.extension:Coverage-Information | If '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-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() | |
| 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: 14 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Differential View
This structure is derived from CommunicationRequest
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| 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 |
| 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) | 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 | CodeableConcept | 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 | US Core PractitionerRole Profile) | Who/what is requesting service |
| recipient | S | 0..* | Reference(CRD Practitioner | US Core PractitionerRole Profile | US Core Organization Profile) | Message recipient |
| sender | SΣ | 0..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile | US Core Organization Profile) | 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(US Core Condition Profile | US Core Laboratory Result Observation Profile) | Why is communication needed? |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| CommunicationRequest.status | required | Fixed Value: draft |
| CommunicationRequest.reasonCode | example | ActReason |
| Id | Grade | Path(s) | Details | Requirements |
| crd-ci-q1 | error | CommunicationRequest.extension:Coverage-Information | Questionnaire 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-q2 | error | CommunicationRequest.extension:Coverage-Information | If 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-q3 | error | CommunicationRequest.extension:Coverage-Information | If '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-q4 | error | CommunicationRequest.extension:Coverage-Information | If '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-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() | |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | ||||
| 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) | 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 | CodeableConcept | 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 | US Core PractitionerRole Profile) | Who/what is requesting service | ||||
| recipient | S | 0..* | Reference(CRD Practitioner | US Core PractitionerRole Profile | US Core Organization Profile) | Message recipient | ||||
| sender | SΣ | 0..1 | Reference(CRD Practitioner | US Core PractitionerRole Profile | US Core Organization Profile) | 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(US Core Condition Profile | US Core Laboratory Result Observation Profile) | Why is communication needed? | ||||
| note | 0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| CommunicationRequest.language | preferred | CommonLanguages
| ||||
| CommunicationRequest.status | required | Fixed Value: draft | ||||
| CommunicationRequest.statusReason | example | |||||
| CommunicationRequest.category | example | CommunicationCategory | ||||
| CommunicationRequest.priority | required | RequestPriority | ||||
| CommunicationRequest.medium | example | ParticipationMode | ||||
| CommunicationRequest.reasonCode | example | ActReason |
| Id | Grade | Path(s) | Details | Requirements |
| crd-ci-q1 | error | CommunicationRequest.extension:Coverage-Information | Questionnaire 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-q2 | error | CommunicationRequest.extension:Coverage-Information | If 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-q3 | error | CommunicationRequest.extension:Coverage-Information | If '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-q4 | error | CommunicationRequest.extension:Coverage-Information | If '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-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() | |
| 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: 14 elements
Fixed Value: 1 element
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
IG © 2019+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-crd#2.0.1 based on FHIR 4.0.1. Generated 2024-01-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
