ServiceRequest - FHIR Resource (r4)
This ServiceRequest Resource uses the FHIR API standard for access and structure.
Validate an ServiceRequest FHIR Resource (r4)
ServiceRequest Attributes
AttributeField is listTypeDescription
Description: Identifiers assigned to this order
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "PLAC"
}
],
"text": "Placer"
},
"system": "urn:oid:1.3.4.5.6.7",
"value": "2345234234234"
}
]Learn more about the (ServiceRequest) identifier FHIR attribute
Description: Instantiates FHIR protocol or definition
FHIR Version: r4
Attribute Type : canonical(ActivityDefinition | PlanDefinition)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesCanonical": Learn more about the (ServiceRequest) instantiatesCanonical FHIR attribute
Description: Instantiates external protocol or definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesUri": Learn more about the (ServiceRequest) instantiatesUri FHIR attribute
Description: What request fulfills
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"basedOn": Learn more about the (ServiceRequest) basedOn FHIR attribute
Description: What request replaces
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"replaces": Learn more about the (ServiceRequest) replaces FHIR attribute
Description: Composite Request ID
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requisition": Learn more about the (ServiceRequest) requisition FHIR attribute
Description: draft | active | on-hold | revoked | completed | entered-in-error | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (ServiceRequest) status FHIR attribute
Description: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"intent": "original-order"Learn more about the (ServiceRequest) intent FHIR attribute
Description: Classification of service
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": Learn more about the (ServiceRequest) category FHIR attribute
Description: routine | urgent | asap | stat
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": Learn more about the (ServiceRequest) priority FHIR attribute
Description: True if service/procedure should not be performed
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"doNotPerform": Learn more about the (ServiceRequest) doNotPerform FHIR attribute
Description: What is being requested/ordered
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": {
"coding": [
{
"system": "http://acme.org/tests",
"code": "LIPID"
}
],
"text": "Lipid Panel"
}Learn more about the (ServiceRequest) code FHIR attribute
Description: C? Additional order information
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"orderDetail": Learn more about the (ServiceRequest) orderDetail FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Quantity|Ratio|Range
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"quantity[x]": Learn more about the (ServiceRequest) quantity[x] FHIR attribute
Description: Individual or Entity the service is ordered for
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (ServiceRequest) subject FHIR attribute
Description: Encounter in which the request was created
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": {
"reference": "Encounter/example"
}Learn more about the (ServiceRequest) encounter FHIR attribute
Description:
FHIR Version: r4
Attribute Type : dateTime|Period|Timing
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrence[x]": Learn more about the (ServiceRequest) occurrence[x] FHIR attribute
Description:
FHIR Version: r4
Attribute Type : boolean|CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"asNeeded[x]": Learn more about the (ServiceRequest) asNeeded[x] FHIR attribute
Description: Date request signed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"authoredOn": Learn more about the (ServiceRequest) authoredOn FHIR attribute
Description: "requester" : { Reference(Practitioner|PractitionerRole|Organization|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requester": {
"reference": "Practitioner/example"
}Learn more about the (ServiceRequest) requester FHIR attribute
Description: Performer role
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performerType": Learn more about the (ServiceRequest) performerType FHIR attribute
Description: "performer" : [{ Reference(Practitioner|PractitionerRole|Organization|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": [
{
"reference": "Practitioner/f202"
}
]Learn more about the (ServiceRequest) performer FHIR attribute
Description: Requested location
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"locationCode": Learn more about the (ServiceRequest) locationCode FHIR attribute
Description: Requested location
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"locationReference": Learn more about the (ServiceRequest) locationReference FHIR attribute
Description: Explanation/Justification for procedure or service
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": [
{
"coding": [
{
"system": "http://hl7.org/fhir/sid/icd-9",
"code": "V173",
"display": "Fam hx-ischem heart dis"
}
]
}
]Learn more about the (ServiceRequest) reasonCode FHIR attribute
Description: "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (ServiceRequest) reasonReference FHIR attribute
Description: Associated insurance coverage
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"insurance": Learn more about the (ServiceRequest) insurance FHIR attribute
Description: Additional clinical information
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supportingInfo": [
{
"reference": "#fasting",
"display": "Fasting status"
}
]Learn more about the (ServiceRequest) supportingInfo FHIR attribute
Description: Procedure Samples
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"specimen": [
{
"reference": "#serum",
"display": "Serum specimen"
}
]Learn more about the (ServiceRequest) specimen FHIR attribute
Description: Location on Body
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"bodySite": Learn more about the (ServiceRequest) bodySite FHIR attribute
Description: Comments
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": [
{
"text": "patient is afraid of needles"
}
]Learn more about the (ServiceRequest) note FHIR attribute
Description: Patient or consumer-oriented instructions
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patientInstruction": Learn more about the (ServiceRequest) patientInstruction FHIR attribute
Description: Request provenance
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relevantHistory": Learn more about the (ServiceRequest) relevantHistory FHIR attribute
ServiceRequest Example
{
"resourceType": "ServiceRequest",
"id": "lipid",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: lipid</p><p><b>contained</b>: , </p><p><b>identifier</b>: Placer = 2345234234234</p><p><b>status</b>: active</p><p><b>intent</b>: original-order</p><p><b>code</b>: Lipid Panel <span>(Details : {http://acme.org/tests code 'LIPID' = 'LIPID)</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrence</b>: 02/05/2013 4:16:00 PM</p><p><b>requester</b>: <a>Practitioner/example</a></p><p><b>performer</b>: <a>Practitioner/f202</a></p><p><b>reasonCode</b>: Fam hx-ischem heart dis <span>(Details : {ICD-9 code 'V173' = 'V173', given as 'Fam hx-ischem heart dis'})</span></p><p><b>supportingInfo</b>: Fasting status. Generated Summary: id: fasting; status: final; Fasting status - Reported <span>(Details : {LOINC code '49541-6' = 'Fasting status - Reported', given as 'Fasting status - Reported'})</span>; Yes <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0136 code 'Y' = 'Yes', given as 'Yes'})</span></p><p><b>specimen</b>: Serum specimen. Generated Summary: id: serum; 20150107-0012; Serum sample <span>(Details : {SNOMED CT code '119364003' = 'Serum specimen', given as 'Serum sample'})</span></p><p><b>note</b>: patient is afraid of needles</p></div>"
},
"contained": [
{
"resourceType": "Observation",
"id": "fasting",
"status": "final",
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "49541-6",
"display": "Fasting status - Reported"
}
]
},
"subject": {
"reference": "Patient/example"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0136",
"code": "Y",
"display": "Yes"
}
]
}
},
{
"resourceType": "Specimen",
"id": "serum",
"identifier": [
{
"system": "http://acme.org/specimens",
"value": "20150107-0012"
}
],
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "119364003",
"display": "Serum sample"
}
]
},
"subject": {
"reference": "Patient/example"
},
"collection": {
"collectedDateTime": "2015-08-16T06:40:17Z"
}
}
],
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "PLAC"
}
],
"text": "Placer"
},
"system": "urn:oid:1.3.4.5.6.7",
"value": "2345234234234"
}
],
"status": "active",
"intent": "original-order",
"code": {
"coding": [
{
"system": "http://acme.org/tests",
"code": "LIPID"
}
],
"text": "Lipid Panel"
},
"subject": {
"reference": "Patient/example"
},
"encounter": {
"reference": "Encounter/example"
},
"occurrenceDateTime": "2013-05-02T16:16:00-07:00",
"requester": {
"reference": "Practitioner/example"
},
"performer": [
{
"reference": "Practitioner/f202"
}
],
"reasonCode": [
{
"coding": [
{
"system": "http://hl7.org/fhir/sid/icd-9",
"code": "V173",
"display": "Fam hx-ischem heart dis"
}
]
}
],
"supportingInfo": [
{
"reference": "#fasting",
"display": "Fasting status"
}
],
"specimen": [
{
"reference": "#serum",
"display": "Serum specimen"
}
],
"note": [
{
"text": "patient is afraid of needles"
}
]
}ServiceRequest Structure
{
"resourceType" : "ServiceRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Identifiers assigned to this order
"instantiatesCanonical" : [{ canonical(ActivityDefinition|PlanDefinition) }], // Instantiates FHIR protocol or definition
"instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
"basedOn" : [{ Reference(CarePlan|ServiceRequest|MedicationRequest) }], // What request fulfills
"replaces" : [{ Reference(ServiceRequest) }], // What request replaces
"requisition" : { Identifier }, // Composite Request ID
"status" : "<code>", // R! draft | active | on-hold | revoked | completed | entered-in-error | unknown
"intent" : "<code>", // R! proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
"category" : [{ CodeableConcept }], // Classification of service
"priority" : "<code>", // routine | urgent | asap | stat
"doNotPerform" : <boolean>, // True if service/procedure should not be performed
"code" : { CodeableConcept }, // What is being requested/ordered
"orderDetail" : [{ CodeableConcept }], // C? Additional order information
// quantity[x]: Service amount. One of these 3:
"quantityQuantity" : { Quantity },
"quantityRatio" : { Ratio },
"quantityRange" : { Range },
"subject" : { Reference(Patient|Group|Location|Device) }, // R! Individual or Entity the service is ordered for
"encounter" : { Reference(Encounter) }, // Encounter in which the request was created
// occurrence[x]: When service should occur. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
// asNeeded[x]: Preconditions for service. One of these 2:
"asNeededBoolean" : <boolean>,
"asNeededCodeableConcept" : { CodeableConcept },
"authoredOn" : "<dateTime>", // Date request signed
"requester" : { Reference(Practitioner|PractitionerRole|Organization|
Patient|RelatedPerson|Device) }, // Who/what is requesting service
"performerType" : { CodeableConcept }, // Performer role
"performer" : [{ Reference(Practitioner|PractitionerRole|Organization|
CareTeam|HealthcareService|Patient|Device|RelatedPerson) }], // Requested performer
"locationCode" : [{ CodeableConcept }], // Requested location
"locationReference" : [{ Reference(Location) }], // Requested location
"reasonCode" : [{ CodeableConcept }], // Explanation/Justification for procedure or service
"reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
DocumentReference) }], // Explanation/Justification for service or service
"insurance" : [{ Reference(Coverage|ClaimResponse) }], // Associated insurance coverage
"supportingInfo" : [{ Reference(Any) }], // Additional clinical information
"specimen" : [{ Reference(Specimen) }], // Procedure Samples
"bodySite" : [{ CodeableConcept }], // Location on Body
"note" : [{ Annotation }], // Comments
"patientInstruction" : "<string>", // Patient or consumer-oriented instructions
"relevantHistory" : [{ Reference(Provenance) }] // Request provenance
}
ServiceRequest Search Parameters
The following search parameters can be used to query ServiceRequest resources. Just submit them like so:
https://api.1up.health/fhir/r4/ServiceRequest?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
authored | date | authoredOn |
based-on | reference | basedOn |
body-site | text | bodySite |
category | text | category |
code | text | code |
encounter | reference | encounter |
identifier | text | identifier |
instantiates-canonical | reference | instantiatesCanonical |
instantiates-uri | uri | instantiatesUri |
intent | text | intent |
occurrence | date | occurrence |
patient | reference | subject.where |
performer | reference | performer |
performer-type | text | performerType |
priority | text | priority |
replaces | reference | replaces |
requester | reference | requester |
requisition | text | requisition |
specimen | reference | specimen |
status | text | status |
subject | reference | subject |
