Da Vinci - Coverage Requirements Discovery
2.1.0-preview - STU 2
Da Vinci - Coverage Requirements Discovery
2.1.0-preview - STU 2
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
| Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest | Version: 2.1.0-preview | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: CRDServiceRequest | ||
This profile specifies constraints on the ServiceRequest resource to support coverage requirements discovery.
CRD Clients SHALL use this profile to resolve references to ServiceRequest 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 USCoreServiceRequestProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest |
USCoreServiceRequestProfile | |||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 Coverage-Information |
S | 0..* | (Complex) | Coverage Info URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information |
 identifier |
S | 0..* | Identifier | Identifiers assigned to this order |
 basedOn |
S | 0..* | Reference(CRD Service Request | CRD Medication Request) | What request fulfills |
| status |
1..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Fixed Value: draft | |
| doNotPerform |
S | 0..1 | boolean | True if service/procedure should not be performed |
| code |
1..1 | CodeableConcept | Codes to identify requested services. (CPT, SNOMED CT or LOINC) Binding: CRD Service Request Codes Value Set (extensible): Codes describing the type of Service | |
| quantity[x] |
S | 0..1 | Quantity, Ratio, Range | Service amount |
| subject |
1..1 | Reference(CRD Patient) | (USCDI) Individual or Entity the service is ordered for | |
| encounter |
0..1 | Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) | Encounter in which the request was created | |
| authoredOn |
1..1 | dateTime | (USCDI) Date request signed | |
| requester |
1..1 | Reference(CRD Practitioner | HRex PractitionerRole Profile) | (USCDI) Who/what is requesting service | |
| performer |
S | 0..* | Reference(CRD Practitioner | HRex PractitionerRole Profile) | Requested performer |
| locationReference |
S | 0..1 | Reference(CRD Location) | Requested location |
| reasonCode |
S | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service |
 reasonReference |
S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | (USCDI) US Core Profile that supports the requested service |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | extensible | CRDServiceRequestCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/serviceRequestCodesfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
 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) | Coverage Info 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 | Identifiers assigned to this order |
| basedOn |
SΣ | 0..* | Reference(CRD Service Request | CRD Medication Request) | What request fulfills |
| status |
?!SΣ | 1..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. Fixed Value: draft |
| intent |
?!SΣ | 1..1 | code | (USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
  Slices for category |
SΣ | 0..* | CodeableConcept | (USCDI) Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
  category:us-core |
SΣ | 0..* | CodeableConcept | (USCDI) Classification of service Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
| doNotPerform |
?!SΣ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 1..1 | CodeableConcept | Codes to identify requested services. (CPT, SNOMED CT or LOINC) Binding: CRD Service Request Codes Value Set (extensible): Codes describing the type of Service |
 quantity[x] |
SΣ | 0..1 | Service amount | |
| quantityQuantity |
Quantity | |||
| quantityRatio |
Ratio | |||
| quantityRange |
Range | |||
| subject |
SΣ | 1..1 | Reference(CRD Patient) | (USCDI) Individual or Entity the service is ordered for |
| encounter |
Σ | 0..1 | Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) | Encounter in which the request was created |
| occurrence[x] |
SΣ | 0..1 | (USCDI) When service should occur | |
| occurrencePeriod |
Period | |||
| authoredOn |
SΣ | 1..1 | dateTime | (USCDI) Date request signed |
| requester |
SΣ | 1..1 | Reference(CRD Practitioner | HRex PractitionerRole Profile) | (USCDI) Who/what is requesting service |
| performer |
SΣ | 0..* | Reference(CRD Practitioner | HRex PractitionerRole Profile) | Requested performer |
| locationReference |
SΣ | 0..1 | Reference(CRD Location) | Requested location |
| reasonCode |
SΣ | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) |
| reasonReference |
SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | (USCDI) US Core Profile that supports the requested service |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | Fixed Value: drafthttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | |
| ServiceRequest.code | extensible | CRDServiceRequestCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/serviceRequestCodesfrom this IG | |
| ServiceRequest.reasonCode | extensible | USCoreConditionCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code |
| Id | Grade | Path(s) | Details | Requirements |
| crd-ci-q1 | error | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | 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() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| 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) | Coverage Info 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 | Identifiers assigned to this order | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
SΣ | 0..* | Reference(CRD Service Request | CRD Medication Request) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. Fixed Value: draft | ||||
| intent |
?!SΣ | 1..1 | code | (USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| Slices for category |
SΣ | 0..* | CodeableConcept | (USCDI) Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:us-core |
SΣ | 0..* | CodeableConcept | (USCDI) Classification of service Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets | ||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!SΣ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 1..1 | CodeableConcept | Codes to identify requested services. (CPT, SNOMED CT or LOINC) Binding: CRD Service Request Codes Value Set (extensible): Codes describing the type of Service | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
SΣ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
SΣ | 1..1 | Reference(CRD Patient) | (USCDI) Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) | Encounter in which the request was created | ||||
| occurrence[x] |
SΣ | 0..1 | (USCDI) When service should occur | |||||
| occurrencePeriod |
Period S | |||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
SΣ | 1..1 | dateTime | (USCDI) Date request signed | ||||
| requester |
SΣ | 1..1 | Reference(CRD Practitioner | HRex PractitionerRole Profile) | (USCDI) Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
SΣ | 0..* | Reference(CRD Practitioner | HRex PractitionerRole Profile) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
SΣ | 0..1 | Reference(CRD Location) | Requested location | ||||
| reasonCode |
SΣ | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) | ||||
| reasonReference |
SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | (USCDI) US Core Profile that supports the requested service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | Fixed Value: drafthttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | extensible | CRDServiceRequestCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/serviceRequestCodesfrom this IG | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | extensible | USCoreConditionCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| crd-ci-q1 | error | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | 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() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from USCoreServiceRequestProfile
Summary
Mandatory: 2 elements
Must-Support: 9 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Differential View
This structure is derived from USCoreServiceRequestProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
USCoreServiceRequestProfile | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Coverage-Information |
S | 0..* | (Complex) | Coverage Info URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information |
| identifier |
S | 0..* | Identifier | Identifiers assigned to this order |
| basedOn |
S | 0..* | Reference(CRD Service Request | CRD Medication Request) | What request fulfills |
| status |
1..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Fixed Value: draft | |
| doNotPerform |
S | 0..1 | boolean | True if service/procedure should not be performed |
| code |
1..1 | CodeableConcept | Codes to identify requested services. (CPT, SNOMED CT or LOINC) Binding: CRD Service Request Codes Value Set (extensible): Codes describing the type of Service | |
| quantity[x] |
S | 0..1 | Quantity, Ratio, Range | Service amount |
| subject |
1..1 | Reference(CRD Patient) | (USCDI) Individual or Entity the service is ordered for | |
| encounter |
0..1 | Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) | Encounter in which the request was created | |
| authoredOn |
1..1 | dateTime | (USCDI) Date request signed | |
| requester |
1..1 | Reference(CRD Practitioner | HRex PractitionerRole Profile) | (USCDI) Who/what is requesting service | |
| performer |
S | 0..* | Reference(CRD Practitioner | HRex PractitionerRole Profile) | Requested performer |
| locationReference |
S | 0..1 | Reference(CRD Location) | Requested location |
| reasonCode |
S | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service |
| reasonReference |
S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | (USCDI) US Core Profile that supports the requested service |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | extensible | CRDServiceRequestCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/serviceRequestCodesfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
| 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) | Coverage Info 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 | Identifiers assigned to this order |
| basedOn |
SΣ | 0..* | Reference(CRD Service Request | CRD Medication Request) | What request fulfills |
| status |
?!SΣ | 1..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. Fixed Value: draft |
| intent |
?!SΣ | 1..1 | code | (USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| Slices for category |
SΣ | 0..* | CodeableConcept | (USCDI) Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:us-core |
SΣ | 0..* | CodeableConcept | (USCDI) Classification of service Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
| doNotPerform |
?!SΣ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 1..1 | CodeableConcept | Codes to identify requested services. (CPT, SNOMED CT or LOINC) Binding: CRD Service Request Codes Value Set (extensible): Codes describing the type of Service |
| quantity[x] |
SΣ | 0..1 | Service amount | |
| quantityQuantity |
Quantity | |||
| quantityRatio |
Ratio | |||
| quantityRange |
Range | |||
| subject |
SΣ | 1..1 | Reference(CRD Patient) | (USCDI) Individual or Entity the service is ordered for |
| encounter |
Σ | 0..1 | Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) | Encounter in which the request was created |
| occurrence[x] |
SΣ | 0..1 | (USCDI) When service should occur | |
| occurrencePeriod |
Period | |||
| authoredOn |
SΣ | 1..1 | dateTime | (USCDI) Date request signed |
| requester |
SΣ | 1..1 | Reference(CRD Practitioner | HRex PractitionerRole Profile) | (USCDI) Who/what is requesting service |
| performer |
SΣ | 0..* | Reference(CRD Practitioner | HRex PractitionerRole Profile) | Requested performer |
| locationReference |
SΣ | 0..1 | Reference(CRD Location) | Requested location |
| reasonCode |
SΣ | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) |
| reasonReference |
SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | (USCDI) US Core Profile that supports the requested service |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | Fixed Value: drafthttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | |
| ServiceRequest.code | extensible | CRDServiceRequestCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/serviceRequestCodesfrom this IG | |
| ServiceRequest.reasonCode | extensible | USCoreConditionCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code |
| Id | Grade | Path(s) | Details | Requirements |
| crd-ci-q1 | error | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | 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() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| 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) | Coverage Info 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 | Identifiers assigned to this order | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
SΣ | 0..* | Reference(CRD Service Request | CRD Medication Request) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. Fixed Value: draft | ||||
| intent |
?!SΣ | 1..1 | code | (USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| Slices for category |
SΣ | 0..* | CodeableConcept | (USCDI) Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:us-core |
SΣ | 0..* | CodeableConcept | (USCDI) Classification of service Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets | ||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!SΣ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 1..1 | CodeableConcept | Codes to identify requested services. (CPT, SNOMED CT or LOINC) Binding: CRD Service Request Codes Value Set (extensible): Codes describing the type of Service | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
SΣ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
SΣ | 1..1 | Reference(CRD Patient) | (USCDI) Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(CRD Encounter - USCDI 1 | CRD Encounter - USCDI 3) | Encounter in which the request was created | ||||
| occurrence[x] |
SΣ | 0..1 | (USCDI) When service should occur | |||||
| occurrencePeriod |
Period S | |||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
SΣ | 1..1 | dateTime | (USCDI) Date request signed | ||||
| requester |
SΣ | 1..1 | Reference(CRD Practitioner | HRex PractitionerRole Profile) | (USCDI) Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
SΣ | 0..* | Reference(CRD Practitioner | HRex PractitionerRole Profile) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
SΣ | 0..1 | Reference(CRD Location) | Requested location | ||||
| reasonCode |
SΣ | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) | ||||
| reasonReference |
SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | (USCDI) US Core Profile that supports the requested service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | Fixed Value: drafthttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | extensible | CRDServiceRequestCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/serviceRequestCodesfrom this IG | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | extensible | USCoreConditionCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| crd-ci-q1 | error | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest.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 | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | 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() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from USCoreServiceRequestProfile
Summary
Mandatory: 2 elements
Must-Support: 9 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-crd#2.1.0-preview based on FHIR 4.0.1. Generated 2024-04-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change