0.3.0 - Second STU ballot

This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: ServiceRequestR4

The official URL for this profile is:

    http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest-r4

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from ServiceRequest

Summary

Mandatory: 8 elements
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-practitioner-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location-r4
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-coverage-r4

This structure is derived from ServiceRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest |  | 0..* |  |
identifier | S | 0..* | Identifier |
instantiatesCanonical | S | 1..1 | canonical(ActivityDefinition | PlanDefinition) |
instantiatesUri |  | 0..* | uri |
basedOn | S | 1..1 | Reference(ServiceRequestR4 | MedicationRequestR4) |
replaces |  | 0..* | Reference(ServiceRequest) |
requisition |  | 0..1 | Identifier |
status | S | 1..1 | code | Fixed Value: draft
intent |  | 1..1 | code |
category |  | 0..* | CodeableConcept |
priority |  | 0..1 | code |
doNotPerform |  | 0..0 |  |
code | S | 1..1 | CodeableConcept |
orderDetail |  | 0..* | CodeableConcept |
quantity[x] |  | 0..1 | Quantity, Ratio, Range |
subject | S | 1..1 | Reference(PatientR4) |
encounter |  | 0..1 | Reference(EncounterR4) |
occurrence[x] | S | 0..1 | dateTime, Period, Timing |
asNeeded[x] |  | 0..1 | boolean, CodeableConcept |
authoredOn | S | 1..1 | dateTime |
requester | S | 1..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
performerType |  | 0..1 | CodeableConcept |
performer | S | 0..* | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
locationCode |  | 0..* | CodeableConcept |
locationReference | S | 1..1 | Reference(LocationR4) |
reasonCode | S | 0..* | CodeableConcept |
reasonReference | S | 0..* | Reference(US Core Condition Profile | US Core Result Observation Profile) |
insurance | S | 0..* | Reference(CoverageR4) |
supportingInfo |  | 0..* | Reference(Resource) |
specimen |  | 0..* | Reference(Specimen) |
note |  | 0..* | Annotation |
patientInstruction |  | 0..1 | string |
relevantHistory |  | 0..* | Reference(Provenance) |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | I | 0..* |  | A request for a service to be performed
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) Max Binding: AllLanguages
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Identifiers assigned to this order
instantiatesCanonical | S Σ | 1..1 | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | S Σ | 1..1 | Reference(ServiceRequestR4 | MedicationRequestR4) | What request fulfills
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces
requisition | Σ | 0..1 | Identifier | Composite Request ID
status | ?!S Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled Binding: RequestStatus (required) Fixed Value: draft
intent | ?!Σ | 1..1 | code | proposal | plan | order + Binding: RequestIntent (required)
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example)
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required)
code | S Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example)
orderDetail | Σ I | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example)
quantity[x] | Σ | 0..1 | Quantity, Ratio, Range | Service amount
subject | S Σ | 1..1 | Reference(PatientR4) | Individual or Entity the service is ordered for
encounter | Σ | 0..1 | Reference(EncounterR4) | Encounter in which the request was created
occurrence[x] | S Σ | 0..1 | dateTime, Period, Timing | When service should occur
asNeeded[x] | Σ | 0..1 | boolean, CodeableConcept | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
authoredOn | S Σ | 1..1 | dateTime | Date request signed
requester | S Σ | 1..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Who/what is requesting service
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example)
performer | S Σ | 0..* | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Requested performer
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
locationReference | S Σ | 1..1 | Reference(LocationR4) | Requested location
reasonCode | S Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example)
reasonReference | S Σ | 0..* | Reference(US Core Condition Profile | US Core Result Observation Profile) | Explanation/Justification for service or service
insurance | S | 0..* | Reference(CoverageR4) | 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)
note |  | 0..* | Annotation | Comments
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions
relevantHistory |  | 0..* | Reference(Provenance) | Request provenance
Documentation for this format

This structure is derived from ServiceRequest

Summary

Mandatory: 8 elements
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-practitioner-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location-r4
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-coverage-r4

Differential View

This structure is derived from ServiceRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest |  | 0..* |  |
identifier | S | 0..* | Identifier |
instantiatesCanonical | S | 1..1 | canonical(ActivityDefinition | PlanDefinition) |
instantiatesUri |  | 0..* | uri |
basedOn | S | 1..1 | Reference(ServiceRequestR4 | MedicationRequestR4) |
replaces |  | 0..* | Reference(ServiceRequest) |
requisition |  | 0..1 | Identifier |
status | S | 1..1 | code | Fixed Value: draft
intent |  | 1..1 | code |
category |  | 0..* | CodeableConcept |
priority |  | 0..1 | code |
doNotPerform |  | 0..0 |  |
code | S | 1..1 | CodeableConcept |
orderDetail |  | 0..* | CodeableConcept |
quantity[x] |  | 0..1 | Quantity, Ratio, Range |
subject | S | 1..1 | Reference(PatientR4) |
encounter |  | 0..1 | Reference(EncounterR4) |
occurrence[x] | S | 0..1 | dateTime, Period, Timing |
asNeeded[x] |  | 0..1 | boolean, CodeableConcept |
authoredOn | S | 1..1 | dateTime |
requester | S | 1..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
performerType |  | 0..1 | CodeableConcept |
performer | S | 0..* | Reference(PractitionerR4 | US Core PractitionerRole Profile) |
locationCode |  | 0..* | CodeableConcept |
locationReference | S | 1..1 | Reference(LocationR4) |
reasonCode | S | 0..* | CodeableConcept |
reasonReference | S | 0..* | Reference(US Core Condition Profile | US Core Result Observation Profile) |
insurance | S | 0..* | Reference(CoverageR4) |
supportingInfo |  | 0..* | Reference(Resource) |
specimen |  | 0..* | Reference(Specimen) |
note |  | 0..* | Annotation |
patientInstruction |  | 0..1 | string |
relevantHistory |  | 0..* | Reference(Provenance) |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | I | 0..* |  | A request for a service to be performed
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) Max Binding: AllLanguages
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Identifiers assigned to this order
instantiatesCanonical | S Σ | 1..1 | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | S Σ | 1..1 | Reference(ServiceRequestR4 | MedicationRequestR4) | What request fulfills
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces
requisition | Σ | 0..1 | Identifier | Composite Request ID
status | ?!S Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled Binding: RequestStatus (required) Fixed Value: draft
intent | ?!Σ | 1..1 | code | proposal | plan | order + Binding: RequestIntent (required)
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example)
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required)
code | S Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example)
orderDetail | Σ I | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example)
quantity[x] | Σ | 0..1 | Quantity, Ratio, Range | Service amount
subject | S Σ | 1..1 | Reference(PatientR4) | Individual or Entity the service is ordered for
encounter | Σ | 0..1 | Reference(EncounterR4) | Encounter in which the request was created
occurrence[x] | S Σ | 0..1 | dateTime, Period, Timing | When service should occur
asNeeded[x] | Σ | 0..1 | boolean, CodeableConcept | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
authoredOn | S Σ | 1..1 | dateTime | Date request signed
requester | S Σ | 1..1 | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Who/what is requesting service
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example)
performer | S Σ | 0..* | Reference(PractitionerR4 | US Core PractitionerRole Profile) | Requested performer
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
locationReference | S Σ | 1..1 | Reference(LocationR4) | Requested location
reasonCode | S Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example)
reasonReference | S Σ | 0..* | Reference(US Core Condition Profile | US Core Result Observation Profile) | Explanation/Justification for service or service
insurance | S | 0..* | Reference(CoverageR4) | 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)
note |  | 0..* | Annotation | Comments
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions
relevantHistory |  | 0..* | Reference(Provenance) | Request provenance
Documentation for this format

Other representations of profile: Schematron

### Terminology Bindings

Path | Conformance | ValueSet / Code
ServiceRequest.status | required | Fixed Value: draft
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)
ServiceRequest.reasonCode | example | ProcedureReasonCodes

### Constraints

Id | Path | Details | Requirements
dom-2 | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-4 | 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-3 | 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-6 | ServiceRequest | A resource should have narrative for robust management : text.div.exists() |
dom-5 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
prr-1 | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |