HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
2.0.0 - STU2 Release 1 - Standard for Trial-Use

Publication Build: This will be filled in by the publication tooling

## Resource Profile: De-Identified UDS Plus ServiceRequest

Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-servicerequest | Version: 2.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: UDSPlusServiceRequest

The UDS+ profile is based on the ServiceRequest resource and establishes the core elements, extensions, vocabularies and value sets for representing ServiceRequest for UDS+ program.

### Introduction

This profile is used to represent de-identified ServiceRequest information. The de-identification process has to remove all data elements not explicitly identified as "SUPPORTED" in the profile.

The HHS De-identification Guidance is to be followed to ensure appropriate level of de-identification is performed.

According to the HHS guidance, dates should not have a precision of more than the year. This means month and day cannot be included. This includes ServiceRequest.occurenceDateTime.

In FHIR Resources, text elements and reference.display elements which provide human readable information to the providers may be generated using programs and tools from the data present within the resource. For e.g a ServiceRequest resource text element may contain information such as the ServiceRequest date, patient information. This type of information will enable identification of the individuals. In order to avoid inadvertent revealing of PII/PHI, text elements cannot be included in the De-identified FHIR resource and the submission will be rejected when text elements are present by the validation process.

Ids and References

The original ServiceRequest resource id should not be included in the De-identified ServiceRequest instance. Instead a new id should be created and provided as part of the FHIR resource. The Data Submitter should be capable of using the generated id to relink the data to the original ServiceRequest. All resource references to the ServiceRequest submitted as part of the UDS+ report should refer to newly generated id.

Resource references cannot contain text element as it may contain PHI/PII. The text element for following references are not allowed

- subject
- encounter

Date Truncation

The Data Submitter has to truncate the following dates to only have a precision of year

- authoredOn

Usage:

- Examples for this Resource Profile: ServiceRequest/de-identified-example

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | ServiceRequest | De-Identified UDS Plus ServiceRequest dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present
id | S Σ | 0..1 | id | The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!S Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children
intent | ?!S Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children
doNotPerform | ?!S Σ | 1..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children
code | S Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests ele-1: All FHIR elements must have a @value or children
subject | S Σ | 1..1 | Reference(De-Identified UDS Plus Patient) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children
encounter | S Σ | 0..1 | Reference(De-Identified UDS Plus Encounter) | Encounter in which the request was created ele-1: All FHIR elements must have a @value or children
occurrence[x] | S Σ C | 0..1 |  | When service should occur ele-1: All FHIR elements must have a @value or children uds-plus-svr-1: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-1a: All dateTime data elements should have valid year > 1900 uds-plus-svr-1b: All dateTime data elements should have valid year < 2030 uds-plus-svr-2: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-svr-2a: All Period.start data elements should have valid year > 1900 uds-plus-svr-2b: All Period.start data elements should have valid year < 2030 uds-plus-svr-3: All Period.emd data elements should be truncated to a year only for de-identified resources. uds-plus-svr-3a: All Period.end data elements should have valid year > 1900 uds-plus-svr-3b: All Period.end data elements should have valid year < 2030 uds-plus-svr-4: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5a: All Timing data elements should have valid year > 1900 uds-plus-svr-5b: All Timing data elements should have valid year < 2030
occurrenceDateTime |  |  | dateTime |
authoredOn | S Σ C | 0..1 | dateTime | Date request signed ele-1: All FHIR elements must have a @value or children uds-plus-svr-6: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-6a: All dateTime data elements should have valid year > 1900 uds-plus-svr-6b: All dateTime data elements should have valid year < 2030
requester | S Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ServiceRequest.status | required | RequestStatus `http://hl7.org/fhir/ValueSet/request-status|4.0.1` from the FHIR Standard
ServiceRequest.intent | required | RequestIntent `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` from the FHIR Standard
ServiceRequest.code | extensible | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
uds-plus-svr-1 | error | ServiceRequest.occurrence[x] | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-1a | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-1b | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |
uds-plus-svr-2 | error | ServiceRequest.occurrence[x] | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-svr-2a | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-svr-2b | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-svr-3 | error | ServiceRequest.occurrence[x] | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-svr-3a | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-svr-3b | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |
uds-plus-svr-4 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.count() = 1 |
uds-plus-svr-5 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4 |
uds-plus-svr-5a | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year > 1900 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900' |
uds-plus-svr-5b | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year < 2030 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030' |
uds-plus-svr-6 | error | ServiceRequest.authoredOn | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-6a | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-6b | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |

This structure is derived from ServiceRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest |  | 0..* | ServiceRequest | De-Identified UDS Plus ServiceRequest
id | S | 0..1 | id | The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
text |  | 0..0 |  |
contained |  | 0..0 |  |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
doNotPerform | S | 1..1 | boolean | True if service/procedure should not be performed
code | S | 1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
subject | S | 1..1 | Reference(De-Identified UDS Plus Patient) | Individual or Entity the service is ordered for
display |  | 0..0 |  |
encounter | S | 0..1 | Reference(De-Identified UDS Plus Encounter) | Encounter in which the request was created
display |  | 0..0 |  |
occurrence[x] | S C | 0..1 |  | When service should occur uds-plus-svr-1: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-1a: All dateTime data elements should have valid year > 1900 uds-plus-svr-1b: All dateTime data elements should have valid year < 2030 uds-plus-svr-2: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-svr-2a: All Period.start data elements should have valid year > 1900 uds-plus-svr-2b: All Period.start data elements should have valid year < 2030 uds-plus-svr-3: All Period.emd data elements should be truncated to a year only for de-identified resources. uds-plus-svr-3a: All Period.end data elements should have valid year > 1900 uds-plus-svr-3b: All Period.end data elements should have valid year < 2030 uds-plus-svr-4: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5a: All Timing data elements should have valid year > 1900 uds-plus-svr-5b: All Timing data elements should have valid year < 2030
occurrenceDateTime |  |  | dateTime S |
occurrencePeriod |  |  | Period |
occurrenceTiming |  |  | Timing |
authoredOn | S C | 0..1 | dateTime | Date request signed uds-plus-svr-6: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-6a: All dateTime data elements should have valid year > 1900 uds-plus-svr-6b: All dateTime data elements should have valid year < 2030
requester | S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service
display |  | 0..0 |  |
performer |  |  |  |
display |  | 0..0 |  |
note |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
ServiceRequest.code | extensible | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
uds-plus-svr-1 | error | ServiceRequest.occurrence[x] | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-1a | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-1b | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |
uds-plus-svr-2 | error | ServiceRequest.occurrence[x] | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-svr-2a | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-svr-2b | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-svr-3 | error | ServiceRequest.occurrence[x] | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-svr-3a | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-svr-3b | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |
uds-plus-svr-4 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.count() = 1 |
uds-plus-svr-5 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4 |
uds-plus-svr-5a | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year > 1900 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900' |
uds-plus-svr-5b | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year < 2030 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030' |
uds-plus-svr-6 | error | ServiceRequest.authoredOn | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-6a | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-6b | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | ServiceRequest | De-Identified UDS Plus ServiceRequest prr-1: orderDetail SHALL only be present if code is present
id | S Σ | 0..1 | id | The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 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 | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces
requisition | Σ | 0..1 | Identifier | Composite Request ID
status | ?!S Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order.
intent | ?!S Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request.
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
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 Σ | 1..1 | boolean | True if service/procedure should not be performed
code | S Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
orderDetail | Σ C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
quantity[x] | Σ | 0..1 |  | Service amount
quantityQuantity |  |  | Quantity |
quantityRatio |  |  | Ratio |
quantityRange |  |  | Range |
subject | S Σ | 1..1 | Reference(De-Identified UDS Plus Patient) | Individual or Entity the service is ordered for
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
encounter | S Σ | 0..1 | Reference(De-Identified UDS Plus Encounter) | Encounter in which the request was created
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
occurrence[x] | S Σ C | 0..1 |  | When service should occur uds-plus-svr-1: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-1a: All dateTime data elements should have valid year > 1900 uds-plus-svr-1b: All dateTime data elements should have valid year < 2030 uds-plus-svr-2: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-svr-2a: All Period.start data elements should have valid year > 1900 uds-plus-svr-2b: All Period.start data elements should have valid year < 2030 uds-plus-svr-3: All Period.emd data elements should be truncated to a year only for de-identified resources. uds-plus-svr-3a: All Period.end data elements should have valid year > 1900 uds-plus-svr-3b: All Period.end data elements should have valid year < 2030 uds-plus-svr-4: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5a: All Timing data elements should have valid year > 1900 uds-plus-svr-5b: All Timing data elements should have valid year < 2030
occurrenceDateTime |  |  | dateTime S |
occurrencePeriod |  |  | Period |
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 Σ C | 0..1 | dateTime | Date request signed uds-plus-svr-6: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-6a: All dateTime data elements should have valid year > 1900 uds-plus-svr-6b: All dateTime data elements should have valid year < 2030
requester | S Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
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 | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
locationReference | Σ | 0..* | Reference(Location) | Requested location
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or 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.
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions
relevantHistory |  | 0..* | Reference(Provenance) | Request provenance
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ServiceRequest.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
ServiceRequest.status | required | RequestStatus `http://hl7.org/fhir/ValueSet/request-status|4.0.1` from the FHIR Standard
ServiceRequest.intent | required | RequestIntent `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` from the FHIR Standard
ServiceRequest.category | example | ServiceRequestCategoryCodes `http://hl7.org/fhir/ValueSet/servicerequest-category` from the FHIR Standard
ServiceRequest.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` from the FHIR Standard
ServiceRequest.code | extensible | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code`
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes `http://hl7.org/fhir/ValueSet/servicerequest-orderdetail` from the FHIR Standard
ServiceRequest.subject.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.encounter.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes `http://hl7.org/fhir/ValueSet/medication-as-needed-reason` from the FHIR Standard
ServiceRequest.requester.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.performerType | example | ParticipantRoles `http://hl7.org/fhir/ValueSet/participant-role` from the FHIR Standard
ServiceRequest.performer.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType`
ServiceRequest.reasonCode | example | ProcedureReasonCodes `http://hl7.org/fhir/ValueSet/procedure-reason` from the FHIR Standard
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures `http://hl7.org/fhir/ValueSet/body-site` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
uds-plus-svr-1 | error | ServiceRequest.occurrence[x] | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-1a | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-1b | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |
uds-plus-svr-2 | error | ServiceRequest.occurrence[x] | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-svr-2a | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-svr-2b | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-svr-3 | error | ServiceRequest.occurrence[x] | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-svr-3a | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-svr-3b | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |
uds-plus-svr-4 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.count() = 1 |
uds-plus-svr-5 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4 |
uds-plus-svr-5a | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year > 1900 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900' |
uds-plus-svr-5b | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year < 2030 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030' |
uds-plus-svr-6 | error | ServiceRequest.authoredOn | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-6a | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-6b | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |

This structure is derived from ServiceRequest

Summary

Mandatory: 5 elements
Must-Support: 10 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

- De-Identified UDS Plus Patient (http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/de-identified-uds-plus-patient)
- De-Identified UDS Plus Encounter (http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-encounter)

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | ServiceRequest | De-Identified UDS Plus ServiceRequest dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present
id | S Σ | 0..1 | id | The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!S Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children
intent | ?!S Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children
doNotPerform | ?!S Σ | 1..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children
code | S Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests ele-1: All FHIR elements must have a @value or children
subject | S Σ | 1..1 | Reference(De-Identified UDS Plus Patient) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children
encounter | S Σ | 0..1 | Reference(De-Identified UDS Plus Encounter) | Encounter in which the request was created ele-1: All FHIR elements must have a @value or children
occurrence[x] | S Σ C | 0..1 |  | When service should occur ele-1: All FHIR elements must have a @value or children uds-plus-svr-1: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-1a: All dateTime data elements should have valid year > 1900 uds-plus-svr-1b: All dateTime data elements should have valid year < 2030 uds-plus-svr-2: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-svr-2a: All Period.start data elements should have valid year > 1900 uds-plus-svr-2b: All Period.start data elements should have valid year < 2030 uds-plus-svr-3: All Period.emd data elements should be truncated to a year only for de-identified resources. uds-plus-svr-3a: All Period.end data elements should have valid year > 1900 uds-plus-svr-3b: All Period.end data elements should have valid year < 2030 uds-plus-svr-4: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5a: All Timing data elements should have valid year > 1900 uds-plus-svr-5b: All Timing data elements should have valid year < 2030
occurrenceDateTime |  |  | dateTime |
authoredOn | S Σ C | 0..1 | dateTime | Date request signed ele-1: All FHIR elements must have a @value or children uds-plus-svr-6: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-6a: All dateTime data elements should have valid year > 1900 uds-plus-svr-6b: All dateTime data elements should have valid year < 2030
requester | S Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ServiceRequest.status | required | RequestStatus `http://hl7.org/fhir/ValueSet/request-status|4.0.1` from the FHIR Standard
ServiceRequest.intent | required | RequestIntent `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` from the FHIR Standard
ServiceRequest.code | extensible | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
uds-plus-svr-1 | error | ServiceRequest.occurrence[x] | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-1a | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-1b | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |
uds-plus-svr-2 | error | ServiceRequest.occurrence[x] | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-svr-2a | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-svr-2b | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-svr-3 | error | ServiceRequest.occurrence[x] | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-svr-3a | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-svr-3b | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |
uds-plus-svr-4 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.count() = 1 |
uds-plus-svr-5 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4 |
uds-plus-svr-5a | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year > 1900 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900' |
uds-plus-svr-5b | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year < 2030 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030' |
uds-plus-svr-6 | error | ServiceRequest.authoredOn | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-6a | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-6b | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |

Differential View

This structure is derived from ServiceRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest |  | 0..* | ServiceRequest | De-Identified UDS Plus ServiceRequest
id | S | 0..1 | id | The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
text |  | 0..0 |  |
contained |  | 0..0 |  |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
doNotPerform | S | 1..1 | boolean | True if service/procedure should not be performed
code | S | 1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
subject | S | 1..1 | Reference(De-Identified UDS Plus Patient) | Individual or Entity the service is ordered for
display |  | 0..0 |  |
encounter | S | 0..1 | Reference(De-Identified UDS Plus Encounter) | Encounter in which the request was created
display |  | 0..0 |  |
occurrence[x] | S C | 0..1 |  | When service should occur uds-plus-svr-1: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-1a: All dateTime data elements should have valid year > 1900 uds-plus-svr-1b: All dateTime data elements should have valid year < 2030 uds-plus-svr-2: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-svr-2a: All Period.start data elements should have valid year > 1900 uds-plus-svr-2b: All Period.start data elements should have valid year < 2030 uds-plus-svr-3: All Period.emd data elements should be truncated to a year only for de-identified resources. uds-plus-svr-3a: All Period.end data elements should have valid year > 1900 uds-plus-svr-3b: All Period.end data elements should have valid year < 2030 uds-plus-svr-4: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5a: All Timing data elements should have valid year > 1900 uds-plus-svr-5b: All Timing data elements should have valid year < 2030
occurrenceDateTime |  |  | dateTime S |
occurrencePeriod |  |  | Period |
occurrenceTiming |  |  | Timing |
authoredOn | S C | 0..1 | dateTime | Date request signed uds-plus-svr-6: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-6a: All dateTime data elements should have valid year > 1900 uds-plus-svr-6b: All dateTime data elements should have valid year < 2030
requester | S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service
display |  | 0..0 |  |
performer |  |  |  |
display |  | 0..0 |  |
note |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
ServiceRequest.code | extensible | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
uds-plus-svr-1 | error | ServiceRequest.occurrence[x] | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-1a | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-1b | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |
uds-plus-svr-2 | error | ServiceRequest.occurrence[x] | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-svr-2a | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-svr-2b | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-svr-3 | error | ServiceRequest.occurrence[x] | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-svr-3a | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-svr-3b | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |
uds-plus-svr-4 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.count() = 1 |
uds-plus-svr-5 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4 |
uds-plus-svr-5a | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year > 1900 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900' |
uds-plus-svr-5b | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year < 2030 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030' |
uds-plus-svr-6 | error | ServiceRequest.authoredOn | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-6a | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-6b | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | ServiceRequest | De-Identified UDS Plus ServiceRequest prr-1: orderDetail SHALL only be present if code is present
id | S Σ | 0..1 | id | The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 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 | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces
requisition | Σ | 0..1 | Identifier | Composite Request ID
status | ?!S Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order.
intent | ?!S Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request.
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
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 Σ | 1..1 | boolean | True if service/procedure should not be performed
code | S Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
orderDetail | Σ C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
quantity[x] | Σ | 0..1 |  | Service amount
quantityQuantity |  |  | Quantity |
quantityRatio |  |  | Ratio |
quantityRange |  |  | Range |
subject | S Σ | 1..1 | Reference(De-Identified UDS Plus Patient) | Individual or Entity the service is ordered for
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
encounter | S Σ | 0..1 | Reference(De-Identified UDS Plus Encounter) | Encounter in which the request was created
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
occurrence[x] | S Σ C | 0..1 |  | When service should occur uds-plus-svr-1: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-1a: All dateTime data elements should have valid year > 1900 uds-plus-svr-1b: All dateTime data elements should have valid year < 2030 uds-plus-svr-2: All Period.start data elements should be truncated to a year only for de-identified resources. uds-plus-svr-2a: All Period.start data elements should have valid year > 1900 uds-plus-svr-2b: All Period.start data elements should have valid year < 2030 uds-plus-svr-3: All Period.emd data elements should be truncated to a year only for de-identified resources. uds-plus-svr-3a: All Period.end data elements should have valid year > 1900 uds-plus-svr-3b: All Period.end data elements should have valid year < 2030 uds-plus-svr-4: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5: All Timing.event data elements should be truncated to a year only for de-identified resources. uds-plus-svr-5a: All Timing data elements should have valid year > 1900 uds-plus-svr-5b: All Timing data elements should have valid year < 2030
occurrenceDateTime |  |  | dateTime S |
occurrencePeriod |  |  | Period |
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 Σ C | 0..1 | dateTime | Date request signed uds-plus-svr-6: All dateTime data elements should be truncated to a year only for de-identified resources. uds-plus-svr-6a: All dateTime data elements should have valid year > 1900 uds-plus-svr-6b: All dateTime data elements should have valid year < 2030
requester | S Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
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 | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
locationReference | Σ | 0..* | Reference(Location) | Requested location
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or 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.
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions
relevantHistory |  | 0..* | Reference(Provenance) | Request provenance
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ServiceRequest.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
ServiceRequest.status | required | RequestStatus `http://hl7.org/fhir/ValueSet/request-status|4.0.1` from the FHIR Standard
ServiceRequest.intent | required | RequestIntent `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` from the FHIR Standard
ServiceRequest.category | example | ServiceRequestCategoryCodes `http://hl7.org/fhir/ValueSet/servicerequest-category` from the FHIR Standard
ServiceRequest.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` from the FHIR Standard
ServiceRequest.code | extensible | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code`
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes `http://hl7.org/fhir/ValueSet/servicerequest-orderdetail` from the FHIR Standard
ServiceRequest.subject.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.encounter.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes `http://hl7.org/fhir/ValueSet/medication-as-needed-reason` from the FHIR Standard
ServiceRequest.requester.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.performerType | example | ParticipantRoles `http://hl7.org/fhir/ValueSet/participant-role` from the FHIR Standard
ServiceRequest.performer.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType`
ServiceRequest.reasonCode | example | ProcedureReasonCodes `http://hl7.org/fhir/ValueSet/procedure-reason` from the FHIR Standard
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures `http://hl7.org/fhir/ValueSet/body-site` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
uds-plus-svr-1 | error | ServiceRequest.occurrence[x] | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-1a | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-1b | error | ServiceRequest.occurrence[x] | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |
uds-plus-svr-2 | error | ServiceRequest.occurrence[x] | All Period.start data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.start.exists() implies $this.start.toString().length() = 4 |
uds-plus-svr-2a | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year > 1900 : $this is Period and Period.start.exists() implies $this.start.toString() >= '1900' |
uds-plus-svr-2b | error | ServiceRequest.occurrence[x] | All Period.start data elements should have valid year < 2030 : $this is Period and Period.start.exists() implies $this.start.toString() <= '2030' |
uds-plus-svr-3 | error | ServiceRequest.occurrence[x] | All Period.emd data elements should be truncated to a year only for de-identified resources. : $this is Period and Period.end.exists() implies $this.end.toString().length() = 4 |
uds-plus-svr-3a | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year > 1900 : $this is Period and Period.end.exists() implies $this.end.toString() >= '1900' |
uds-plus-svr-3b | error | ServiceRequest.occurrence[x] | All Period.end data elements should have valid year < 2030 : $this is Period and Period.end.exists() implies $this.end.toString() <= '2030' |
uds-plus-svr-4 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.count() = 1 |
uds-plus-svr-5 | error | ServiceRequest.occurrence[x] | All Timing.event data elements should be truncated to a year only for de-identified resources. : $this is Timing and Timing.event.exists() implies $this.event.first().toString().length() = 4 |
uds-plus-svr-5a | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year > 1900 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() >= '1900' |
uds-plus-svr-5b | error | ServiceRequest.occurrence[x] | All Timing data elements should have valid year < 2030 : $this is Timing and Timing.event.exists() implies $this.event.first().toString() <= '2030' |
uds-plus-svr-6 | error | ServiceRequest.authoredOn | All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4 |
uds-plus-svr-6a | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year > 1900 : $this is DateTime implies $this.toString() >= '1900' |
uds-plus-svr-6b | error | ServiceRequest.authoredOn | All dateTime data elements should have valid year < 2030 : $this is DateTime implies $this.toString() <= '2030' |

This structure is derived from ServiceRequest

Summary

Mandatory: 5 elements
Must-Support: 10 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

- De-Identified UDS Plus Patient (http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/de-identified-uds-plus-patient)
- De-Identified UDS Plus Encounter (http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-encounter)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron