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

HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG, published by HRSA BPHC. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/drajer-health/uds-plus/ and changes regularly. See the Directory of published versions

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest De-Identified UDS Plus ServiceRequest
Constraints: prr-1
ServiceRequest.id This element must be supported. This element is included in summaries. 0..1 id The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(De-Identified UDS Plus Patient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(De-Identified UDS Plus Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element must be supported. This element is included in summaries. C 0..1 When service should occur
Constraints: uds-plus-svr-1, uds-plus-svr-1a, uds-plus-svr-1b, uds-plus-svr-2, uds-plus-svr-2a, uds-plus-svr-2b, uds-plus-svr-3, uds-plus-svr-3a, uds-plus-svr-3b, uds-plus-svr-4, uds-plus-svr-5, uds-plus-svr-5a, uds-plus-svr-5b
ServiceRequest.occurrence[x].occurrenceDateTime dateTime This target must be supported.
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. C 0..1 dateTime Date request signed
Constraints: uds-plus-svr-6, uds-plus-svr-6a, uds-plus-svr-6b
ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.code Base extensible US Core Procedure Codes 📦6.1.0 US Core v6.1

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest 0..* ServiceRequest De-Identified UDS Plus ServiceRequest
ServiceRequest.id This element must be supported. 0..1 id The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
ServiceRequest.text 0..0 Cannot include any text in the resource as part of the de-identified data.
ServiceRequest.contained 0..0 Cannot include any contained resources in the resource as part of the de-identified data.
ServiceRequest.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
ServiceRequest.doNotPerform This element must be supported. 1..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. 1..1 CodeableConcept What is being requested/ordered
Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
ServiceRequest.subject This element must be supported. 1..1 Reference(De-Identified UDS Plus Patient) Individual or Entity the service is ordered for
ServiceRequest.subject.display 0..0 Text alternative for the resource
ServiceRequest.encounter This element must be supported. 0..1 Reference(De-Identified UDS Plus Encounter) Encounter in which the request was created
ServiceRequest.encounter.display 0..0 Text alternative for the resource
ServiceRequest.occurrence[x] This element must be supported. C 0..1 When service should occur
Constraints: uds-plus-svr-1, uds-plus-svr-1a, uds-plus-svr-1b, uds-plus-svr-2, uds-plus-svr-2a, uds-plus-svr-2b, uds-plus-svr-3, uds-plus-svr-3a, uds-plus-svr-3b, uds-plus-svr-4, uds-plus-svr-5, uds-plus-svr-5a, uds-plus-svr-5b
ServiceRequest.occurrence[x].occurrenceDateTime dateTime This target must be supported.
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.authoredOn This element must be supported. C 0..1 dateTime Date request signed
Constraints: uds-plus-svr-6, uds-plus-svr-6a, uds-plus-svr-6b
ServiceRequest.requester This element must be supported. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ServiceRequest.requester.display 0..0 Text alternative for the resource
ServiceRequest.performer
ServiceRequest.performer.display 0..0 Text alternative for the resource
ServiceRequest.note 0..0 Comments

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.code Base extensible US Core Procedure Codes 📦6.1.0 US Core v6.1

Constraints

Id Grade Path(s) Description Expression
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'
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest De-Identified UDS Plus ServiceRequest
Constraints: prr-1
ServiceRequest.id This element must be supported. This element is included in summaries. 0..1 id The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ServiceRequest.extension 0..* Extension Additional content defined by implementations
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.identifier This element is included in summaries. 0..* Identifier Identifiers assigned to this order
ServiceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
ServiceRequest.basedOn This element is included in summaries. 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Composite Request ID
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.category This element is included in summaries. 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
ServiceRequest.orderDetail This element is included in summaries. C 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
ServiceRequest.quantity[x] This element is included in summaries. 0..1 Service amount
ServiceRequest.quantity[x].quantityQuantity Quantity
ServiceRequest.quantity[x].quantityRatio Ratio
ServiceRequest.quantity[x].quantityRange Range
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(De-Identified UDS Plus Patient) Individual or Entity the service is ordered for
ServiceRequest.subject.id 0..1 string Unique id for inter-element referencing
ServiceRequest.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.subject.type This element is included in summaries. 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).
ServiceRequest.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(De-Identified UDS Plus Encounter) Encounter in which the request was created
ServiceRequest.encounter.id 0..1 string Unique id for inter-element referencing
ServiceRequest.encounter.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.encounter.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.encounter.type This element is included in summaries. 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).
ServiceRequest.encounter.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.occurrence[x] This element must be supported. This element is included in summaries. C 0..1 When service should occur
Constraints: uds-plus-svr-1, uds-plus-svr-1a, uds-plus-svr-1b, uds-plus-svr-2, uds-plus-svr-2a, uds-plus-svr-2b, uds-plus-svr-3, uds-plus-svr-3a, uds-plus-svr-3b, uds-plus-svr-4, uds-plus-svr-5, uds-plus-svr-5a, uds-plus-svr-5b
ServiceRequest.occurrence[x].occurrenceDateTime dateTime This target must be supported.
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.asNeeded[x] This element is included in summaries. 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.
ServiceRequest.asNeeded[x].asNeededBoolean boolean
ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. C 0..1 dateTime Date request signed
Constraints: uds-plus-svr-6, uds-plus-svr-6a, uds-plus-svr-6b
ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ServiceRequest.requester.id 0..1 string Unique id for inter-element referencing
ServiceRequest.requester.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.requester.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.requester.type This element is included in summaries. 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).
ServiceRequest.requester.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.performerType This element is included in summaries. 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.
ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
ServiceRequest.performer.id 0..1 string Unique id for inter-element referencing
ServiceRequest.performer.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.performer.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.performer.type This element is included in summaries. 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).
ServiceRequest.performer.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.locationCode This element is included in summaries. 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
ServiceRequest.locationReference This element is included in summaries. 0..* Reference(Location) Requested location
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
ServiceRequest.supportingInfo 0..* Reference(Resource) Additional clinical information
ServiceRequest.specimen This element is included in summaries. 0..* Reference(Specimen) Procedure Samples
ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ServiceRequest.patientInstruction This element is included in summaries. 0..1 string Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base extensible US Core Procedure Codes 📦6.1.0 US Core v6.1
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
ServiceRequest.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
ServiceRequest.encounter.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.requester.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.4
ServiceRequest.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest De-Identified UDS Plus ServiceRequest
Constraints: prr-1
ServiceRequest.id This element must be supported. This element is included in summaries. 0..1 id The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(De-Identified UDS Plus Patient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(De-Identified UDS Plus Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element must be supported. This element is included in summaries. C 0..1 When service should occur
Constraints: uds-plus-svr-1, uds-plus-svr-1a, uds-plus-svr-1b, uds-plus-svr-2, uds-plus-svr-2a, uds-plus-svr-2b, uds-plus-svr-3, uds-plus-svr-3a, uds-plus-svr-3b, uds-plus-svr-4, uds-plus-svr-5, uds-plus-svr-5a, uds-plus-svr-5b
ServiceRequest.occurrence[x].occurrenceDateTime dateTime This target must be supported.
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. C 0..1 dateTime Date request signed
Constraints: uds-plus-svr-6, uds-plus-svr-6a, uds-plus-svr-6b
ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.code Base extensible US Core Procedure Codes 📦6.1.0 US Core v6.1

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest 0..* ServiceRequest De-Identified UDS Plus ServiceRequest
ServiceRequest.id This element must be supported. 0..1 id The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
ServiceRequest.text 0..0 Cannot include any text in the resource as part of the de-identified data.
ServiceRequest.contained 0..0 Cannot include any contained resources in the resource as part of the de-identified data.
ServiceRequest.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
ServiceRequest.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
ServiceRequest.doNotPerform This element must be supported. 1..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. 1..1 CodeableConcept What is being requested/ordered
Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
ServiceRequest.subject This element must be supported. 1..1 Reference(De-Identified UDS Plus Patient) Individual or Entity the service is ordered for
ServiceRequest.subject.display 0..0 Text alternative for the resource
ServiceRequest.encounter This element must be supported. 0..1 Reference(De-Identified UDS Plus Encounter) Encounter in which the request was created
ServiceRequest.encounter.display 0..0 Text alternative for the resource
ServiceRequest.occurrence[x] This element must be supported. C 0..1 When service should occur
Constraints: uds-plus-svr-1, uds-plus-svr-1a, uds-plus-svr-1b, uds-plus-svr-2, uds-plus-svr-2a, uds-plus-svr-2b, uds-plus-svr-3, uds-plus-svr-3a, uds-plus-svr-3b, uds-plus-svr-4, uds-plus-svr-5, uds-plus-svr-5a, uds-plus-svr-5b
ServiceRequest.occurrence[x].occurrenceDateTime dateTime This target must be supported.
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.authoredOn This element must be supported. C 0..1 dateTime Date request signed
Constraints: uds-plus-svr-6, uds-plus-svr-6a, uds-plus-svr-6b
ServiceRequest.requester This element must be supported. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ServiceRequest.requester.display 0..0 Text alternative for the resource
ServiceRequest.performer
ServiceRequest.performer.display 0..0 Text alternative for the resource
ServiceRequest.note 0..0 Comments

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.code Base extensible US Core Procedure Codes 📦6.1.0 US Core v6.1

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest De-Identified UDS Plus ServiceRequest
Constraints: prr-1
ServiceRequest.id This element must be supported. This element is included in summaries. 0..1 id The de-identified ServiceRequest identifier created by the health center to send data to UDS+ Data Receiver
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ServiceRequest.extension 0..* Extension Additional content defined by implementations
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.identifier This element is included in summaries. 0..* Identifier Identifiers assigned to this order
ServiceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
ServiceRequest.basedOn This element is included in summaries. 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Composite Request ID
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.category This element is included in summaries. 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
Binding: US Core Procedure Codes (extensible): The set of codes indicating the ServiceRequests
ServiceRequest.orderDetail This element is included in summaries. C 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
ServiceRequest.quantity[x] This element is included in summaries. 0..1 Service amount
ServiceRequest.quantity[x].quantityQuantity Quantity
ServiceRequest.quantity[x].quantityRatio Ratio
ServiceRequest.quantity[x].quantityRange Range
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(De-Identified UDS Plus Patient) Individual or Entity the service is ordered for
ServiceRequest.subject.id 0..1 string Unique id for inter-element referencing
ServiceRequest.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.subject.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.subject.type This element is included in summaries. 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).
ServiceRequest.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(De-Identified UDS Plus Encounter) Encounter in which the request was created
ServiceRequest.encounter.id 0..1 string Unique id for inter-element referencing
ServiceRequest.encounter.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.encounter.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.encounter.type This element is included in summaries. 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).
ServiceRequest.encounter.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.occurrence[x] This element must be supported. This element is included in summaries. C 0..1 When service should occur
Constraints: uds-plus-svr-1, uds-plus-svr-1a, uds-plus-svr-1b, uds-plus-svr-2, uds-plus-svr-2a, uds-plus-svr-2b, uds-plus-svr-3, uds-plus-svr-3a, uds-plus-svr-3b, uds-plus-svr-4, uds-plus-svr-5, uds-plus-svr-5a, uds-plus-svr-5b
ServiceRequest.occurrence[x].occurrenceDateTime dateTime This target must be supported.
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.asNeeded[x] This element is included in summaries. 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.
ServiceRequest.asNeeded[x].asNeededBoolean boolean
ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. C 0..1 dateTime Date request signed
Constraints: uds-plus-svr-6, uds-plus-svr-6a, uds-plus-svr-6b
ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
ServiceRequest.requester.id 0..1 string Unique id for inter-element referencing
ServiceRequest.requester.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.requester.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.requester.type This element is included in summaries. 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).
ServiceRequest.requester.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.performerType This element is included in summaries. 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.
ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
ServiceRequest.performer.id 0..1 string Unique id for inter-element referencing
ServiceRequest.performer.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.performer.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.performer.type This element is included in summaries. 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).
ServiceRequest.performer.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.locationCode This element is included in summaries. 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
ServiceRequest.locationReference This element is included in summaries. 0..* Reference(Location) Requested location
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
ServiceRequest.supportingInfo 0..* Reference(Resource) Additional clinical information
ServiceRequest.specimen This element is included in summaries. 0..* Reference(Specimen) Procedure Samples
ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ServiceRequest.patientInstruction This element is included in summaries. 0..1 string Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base extensible US Core Procedure Codes 📦6.1.0 US Core v6.1
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
ServiceRequest.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
ServiceRequest.encounter.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.requester.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.4
ServiceRequest.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

 

Other representations of profile: CSV, Excel, Schematron