ServiceRequest
| Property | Value |
|---|---|
| Publisher | |
| Name | ServiceRequest |
| URL | http://hl7.org/fhir/StructureDefinition/ServiceRequest |
| Status | draft |
| Description | |
| Abstract | false |
Structure
| Path | Cardinality | Type | Description |
|---|---|---|---|
| ServiceRequest | 0..* | ServiceRequest | A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. |
| ServiceRequest.id | 0..1 | http://hl7.org/fhirpath/System.String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| ServiceRequest.meta | 0..1 | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| ServiceRequest.implicitRules | 0..1 | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| ServiceRequest.language | 0..1 | code | The base language in which the resource is written. |
| ServiceRequest.text | 0..1 | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| ServiceRequest.contained | 0..* | Resource | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
| ServiceRequest.extension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| ServiceRequest.modifierExtension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| ServiceRequest.identifier | 0..* | Identifier | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
| ServiceRequest.instantiatesCanonical | 0..* | canonical | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
| ServiceRequest.instantiatesUri | 0..* | uri | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
| ServiceRequest.basedOn | 0..* | Reference | Plan/proposal/order fulfilled by this request. |
| ServiceRequest.replaces | 0..* | Reference | The request takes the place of the referenced completed or terminated request(s). |
| ServiceRequest.requisition | 0..1 | Identifier | A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
| ServiceRequest.status | 1..1 | code | The status of the order. |
| ServiceRequest.intent | 1..1 | code | Whether the request is a proposal, plan, an original order or a reflex order. |
| ServiceRequest.category | 0..* | CodeableConcept | A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). |
| ServiceRequest.priority | 0..1 | code | Indicates how quickly the ServiceRequest should be addressed with respect to other requests. |
| ServiceRequest.doNotPerform | 0..1 | boolean | Set this to true if the record is saying that the service/procedure should NOT be performed. |
| ServiceRequest.code | 0..1 | CodeableConcept | A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. |
| ServiceRequest.orderDetail | 0..* | CodeableConcept | Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. |
| ServiceRequest.quantity[x] | 0..1 | Quantity | An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
| ServiceRequest.subject | 1..1 | Reference | On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
| ServiceRequest.encounter | 0..1 | Reference | An encounter that provides additional information about the healthcare context in which this request is made. |
| ServiceRequest.occurrence[x] | 0..1 | dateTime | The date/time at which the requested service should occur. |
| ServiceRequest.asNeeded[x] | 0..1 | boolean | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. |
| ServiceRequest.authoredOn | 0..1 | dateTime | When the request transitioned to being actionable. |
| ServiceRequest.requester | 0..1 | Reference | The individual who initiated the request and has responsibility for its activation. |
| ServiceRequest.performerType | 0..1 | CodeableConcept | Desired type of performer for doing the requested service. |
| ServiceRequest.performer | 0..* | Reference | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
| ServiceRequest.locationCode | 0..* | CodeableConcept | The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. |
| ServiceRequest.locationReference | 0..* | Reference | A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. |
| ServiceRequest.reasonCode | 0..* | CodeableConcept | An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`. |
| ServiceRequest.reasonReference | 0..* | Reference | Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. |
| ServiceRequest.insurance | 0..* | Reference | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
| ServiceRequest.supportingInfo | 0..* | Reference | Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
| ServiceRequest.specimen | 0..* | Reference | One or more specimens that the laboratory procedure will use. |
| ServiceRequest.bodySite | 0..* | CodeableConcept | Anatomic location where the procedure should be performed. This is the target site. |
| ServiceRequest.note | 0..* | Annotation | Any other notes and comments made about the service request. For example, internal billing notes. |
| ServiceRequest.patientInstruction | 0..1 | string | Instructions in terms that are understood by the patient or consumer. |
| ServiceRequest.relevantHistory | 0..* | Reference | Key events in the history of the request. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| _text | string | Search on the narrative of the resource | |
| _content | string | Search on the entire content of the resource | |
| _filter | token | Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details | |
| _has | string | Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation | |
| _id | token | Logical id of this artifact | Resource.id |
| _lastUpdated | date | When the resource version last changed | Resource.meta.lastUpdated |
| _list | string | All resources in nominated list (by id, Type/id, url or one of the magic List types) | |
| _profile | uri | Profiles this resource claims to conform to | Resource.meta.profile |
| _query | token | A custom search profile that describes a specific defined query operation | |
| _security | token | Security Labels applied to this resource | Resource.meta.security |
| _source | uri | Identifies where the resource comes from | Resource.meta.source |
| _tag | token | Tags applied to this resource | Resource.meta.tag |
| _text | string | Search on the narrative text (html) of the resource | |
| _type | token | Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion | |
| 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 | AllergyIntolerance.code / AllergyIntolerance.reaction.substance / Condition.code / (DeviceRequest.code.ofType(CodeableConcept)) / DiagnosticReport.code / FamilyMemberHistory.condition.code / List.code / Medication.code / (MedicationAdministration.medication.ofType(CodeableConcept)) / (MedicationDispense.medication.ofType(CodeableConcept)) / (MedicationRequest.medication.ofType(CodeableConcept)) / (MedicationStatement.medication.ofType(CodeableConcept)) / Observation.code / Procedure.code / ServiceRequest.code |
| 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 | AllergyIntolerance.identifier / CarePlan.identifier / CareTeam.identifier / Composition.identifier / Condition.identifier / Consent.identifier / DetectedIssue.identifier / DeviceRequest.identifier / DiagnosticReport.identifier / DocumentManifest.masterIdentifier / DocumentManifest.identifier / DocumentReference.masterIdentifier / DocumentReference.identifier / Encounter.identifier / EpisodeOfCare.identifier / FamilyMemberHistory.identifier / Goal.identifier / ImagingStudy.identifier / Immunization.identifier / List.identifier / MedicationAdministration.identifier / MedicationDispense.identifier / MedicationRequest.identifier / MedicationStatement.identifier / NutritionOrder.identifier / Observation.identifier / Procedure.identifier / RiskAssessment.identifier / ServiceRequest.identifier / SupplyDelivery.identifier / SupplyRequest.identifier / VisionPrescription.identifier |
| 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 | AllergyIntolerance.patient / CarePlan.subject.where(resolve() is Patient) / CareTeam.subject.where(resolve() is Patient) / ClinicalImpression.subject.where(resolve() is Patient) / Composition.subject.where(resolve() is Patient) / Condition.subject.where(resolve() is Patient) / Consent.patient / DetectedIssue.patient / DeviceRequest.subject.where(resolve() is Patient) / DeviceUseStatement.subject.where(resolve() is Patient) / DiagnosticReport.subject.where(resolve() is Patient) / DocumentManifest.subject.where(resolve() is Patient) / DocumentReference.subject.where(resolve() is Patient) / Encounter.subject.where(resolve() is Patient) / EpisodeOfCare.patient / FamilyMemberHistory.patient / Flag.subject.where(resolve() is Patient) / Goal.subject.where(resolve() is Patient) / ImagingStudy.subject.where(resolve() is Patient) / Immunization.patient / List.subject.where(resolve() is Patient) / MedicationAdministration.subject.where(resolve() is Patient) / MedicationDispense.subject.where(resolve() is Patient) / MedicationRequest.subject.where(resolve() is Patient) / MedicationStatement.subject.where(resolve() is Patient) / NutritionOrder.patient / Observation.subject.where(resolve() is Patient) / Procedure.subject.where(resolve() is Patient) / RiskAssessment.subject.where(resolve() is Patient) / ServiceRequest.subject.where(resolve() is Patient) / SupplyDelivery.patient / VisionPrescription.patient |
| 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 | Composition.encounter / DeviceRequest.encounter / DiagnosticReport.encounter / DocumentReference.context.encounter.where(resolve() is Encounter) / Flag.encounter / List.encounter / NutritionOrder.encounter / Observation.encounter / Procedure.encounter / RiskAssessment.encounter / ServiceRequest.encounter / VisionPrescription.encounter |
| authored | date | Date request signed | ServiceRequest.authoredOn |
| based-on | reference | What request fulfills | ServiceRequest.basedOn |
| body-site | token | Where procedure is going to be done | ServiceRequest.bodySite |
| category | token | Classification of service | ServiceRequest.category |
| instantiates-canonical | reference | Instantiates FHIR protocol or definition | ServiceRequest.instantiatesCanonical |
| instantiates-uri | uri | Instantiates external protocol or definition | ServiceRequest.instantiatesUri |
| intent | token | proposal / plan / directive / order / original-order / reflex-order / filler-order / instance-order / option | ServiceRequest.intent |
| occurrence | date | When service should occur | ServiceRequest.occurrence |
| performer | reference | Requested performer | ServiceRequest.performer |
| performer-type | token | Performer role | ServiceRequest.performerType |
| priority | token | routine / urgent / asap / stat | ServiceRequest.priority |
| replaces | reference | What request replaces | ServiceRequest.replaces |
| requester | reference | Who/what is requesting service | ServiceRequest.requester |
| requisition | token | Composite Request ID | ServiceRequest.requisition |
| specimen | reference | Specimen to be tested | ServiceRequest.specimen |
| status | token | draft / active / on-hold / revoked / completed / entered-in-error / unknown | ServiceRequest.status |
| subject | reference | Search by subject | ServiceRequest.subject |