ServiceRequest
A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/ServiceRequest/[id] |
| Vread | GET | /fhir/R4/ServiceRequest/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/ServiceRequest/[id] |
| Patch | PATCH | /fhir/R4/ServiceRequest/[id] |
| Delete | DELETE | /fhir/R4/ServiceRequest/[id] |
| Create | POST | /fhir/R4/ServiceRequest |
| Search | GET | /fhir/R4/ServiceRequest |
| History | GET | /fhir/R4/ServiceRequest/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Identifiers assigned to this order |
instantiatesCanonical | canonical | 0..* | Instantiates FHIR protocol or definition |
instantiatesUri | uri | 0..* | Instantiates external protocol or definition |
basedOn | Reference | 0..* | What request fulfills |
replaces | Reference | 0..* | What request replaces |
requisition | Identifier | 0..1 | Composite Request ID |
status | code | 1..1 | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | code | 1..1 | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
category | CodeableConcept | 0..* | Classification of service |
priority | code | 0..1 | routine | urgent | asap | stat |
doNotPerform | boolean | 0..1 | True if service/procedure should not be performed |
code | CodeableConcept | 0..1 | What is being requested/ordered |
orderDetail | CodeableConcept | 0..* | Additional order information |
quantity[x] | Quantity, Ratio, Range | 0..1 | Service amount |
subject | Reference | 1..1 | Individual or Entity the service is ordered for |
encounter | Reference | 0..1 | Encounter in which the request was created |
occurrence[x] | dateTime, Period, Timing | 0..1 | When service should occur |
asNeeded[x] | boolean, CodeableConcept | 0..1 | Preconditions for service |
authoredOn | dateTime | 0..1 | Date request signed |
requester | Reference | 0..1 | Who/what is requesting service |
performerType | CodeableConcept | 0..1 | Performer role |
performer | Reference | 0..* | Requested performer |
locationCode | CodeableConcept | 0..* | Requested location |
locationReference | Reference | 0..* | Requested location |
reasonCode | CodeableConcept | 0..* | Explanation/Justification for procedure or service |
reasonReference | Reference | 0..* | Explanation/Justification for service or service |
insurance | Reference | 0..* | Associated insurance coverage |
supportingInfo | Reference | 0..* | Additional clinical information |
specimen | Reference | 0..* | Procedure Samples |
bodySite | CodeableConcept | 0..* | Location on Body |
note | Annotation | 0..* | Comments |
patientInstruction | string | 0..1 | Patient or consumer-oriented instructions |
relevantHistory | Reference | 0..* | Request provenance |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
authored | date | Date request signed |
based-on | reference | What request fulfills |
body-site | token | Where procedure is going to be done |
category | token | Classification of service |
code | token | Multiple Resources: AllergyIntolerance: Code that identifies the allergy or intolerance ; Condition: Code for the condition ; DeviceRequest: Code for what is being requested/ordered ; DiagnosticReport: The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result ; FamilyMemberHistory: A search by a condition code ; List: What the purpose of this list is ; Medication: Returns medications for a specific code ; MedicationAdministration: Return administrations of this medication code ; MedicationDispense: Returns dispenses of this medicine code ; MedicationRequest: Return prescriptions of this medication code ; MedicationStatement: Return statements of this medication code ; Observation: The code of the observation type ; Procedure: A code to identify a procedure ; ServiceRequest: What is being requested/ordered |
encounter | reference | Multiple Resources: Composition: Context of the Composition ; DeviceRequest: Encounter during which request was created ; DiagnosticReport: The Encounter when the order was made ; DocumentReference: Context of the document content ; Flag: Alert relevant during encounter ; List: Context in which list created ; NutritionOrder: Return nutrition orders with this encounter identifier ; Observation: Encounter related to the observation ; Procedure: Encounter created as part of ; RiskAssessment: Where was assessment performed? ; ServiceRequest: An encounter in which this request is made ; VisionPrescription: Return prescriptions with this encounter identifier |
identifier | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier |
instantiates-canonical | reference | Instantiates FHIR protocol or definition |
instantiates-uri | uri | Instantiates external protocol or definition |
intent | token | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
occurrence | date | When service should occur |
patient | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations for ; MedicationDispense: The identity of a patient to list dispenses for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for |
performer | reference | Requested performer |
performer-type | token | Performer role |
priority | token | routine | urgent | asap | stat |
replaces | reference | What request replaces |
requester | reference | Who/what is requesting service |
requisition | token | Composite Request ID |
specimen | reference | Specimen to be tested |
status | token | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
subject | reference | Search by subject |
Reference
Official FHIR R4 spec: ServiceRequest.
Maturity: Trial Use 2 (FMM 2).