ProcedureRequest - FHIR Resource (stu3)
This ProcedureRequest Resource uses the FHIR API standard for access and structure.
Validate an ProcedureRequest FHIR Resource (stu3)
ProcedureRequest Attributes
AttributeField is listTypeDescription
Description: What is being requested/ordered
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": {
"coding": [
{
"code": "303653007",
"system": "http://snomed.info/sct",
"display": "Computed tomography of head"
}
]
}Learn more about the (ProcedureRequest) code FHIR attribute
Description: Request provenance
FHIR Version: stu3
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 (ProcedureRequest) relevantHistory FHIR attribute
Description: "performer" : { Reference(Practitioner|Organization|Patient|Device|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": Learn more about the (ProcedureRequest) performer FHIR attribute
Description: Location on Body
FHIR Version: stu3
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 (ProcedureRequest) bodySite FHIR attribute
Description: Explanation/Justification for test
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": Learn more about the (ProcedureRequest) reasonCode FHIR attribute
Description: "asNeededBoolean" : <boolean>,
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"asNeededBoolean": Learn more about the (ProcedureRequest) asNeededBoolean FHIR attribute
Description: Individual the service is ordered for
FHIR Version: stu3
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 (ProcedureRequest) subject FHIR attribute
Description: Classification of procedure
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"text": "Diagnostics Procedure",
"coding": [
{
"code": "103693007",
"system": "http://snomed.info/sct",
"display": "Diagnostic procedure (procedure)"
}
]
}
]Learn more about the (ProcedureRequest) category FHIR attribute
Description: Comments
FHIR Version: stu3
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (ProcedureRequest) note FHIR attribute
Description: "asNeededCodeableConcept" : { CodeableConcept },
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"asNeededCodeableConcept": Learn more about the (ProcedureRequest) asNeededCodeableConcept FHIR attribute
Description: What request fulfills
FHIR Version: stu3
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 (ProcedureRequest) basedOn FHIR attribute
Description: routine | urgent | asap | stat
FHIR Version: stu3
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 (ProcedureRequest) priority FHIR attribute
Description: "occurrencePeriod" : { Period },
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrencePeriod": Learn more about the (ProcedureRequest) occurrencePeriod FHIR attribute
Description: draft | active | suspended | completed | entered-in-error | cancelled
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "completed"Learn more about the (ProcedureRequest) status FHIR attribute
Description: Procedure Samples
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"specimen": Learn more about the (ProcedureRequest) specimen FHIR attribute
Description: Additional clinical information
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supportingInfo": Learn more about the (ProcedureRequest) supportingInfo FHIR attribute
Description: What request replaces
FHIR Version: stu3
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 (ProcedureRequest) replaces FHIR attribute
Description: proposal | plan | order +
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"intent": "order"Learn more about the (ProcedureRequest) intent FHIR attribute
Description: Who/what is requesting procedure or diagnostic
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requester": Learn more about the (ProcedureRequest) requester FHIR attribute
Description: "occurrenceDateTime" : "<dateTime>",
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceDateTime": Learn more about the (ProcedureRequest) occurrenceDateTime FHIR attribute
Description: Protocol or definition
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"definition": Learn more about the (ProcedureRequest) definition FHIR attribute
Description: Date request signed
FHIR Version: stu3
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 (ProcedureRequest) authoredOn FHIR attribute
Description: Explanation/Justification for test
FHIR Version: stu3
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 (ProcedureRequest) reasonReference FHIR attribute
Description: Performer role
FHIR Version: stu3
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 (ProcedureRequest) performerType FHIR attribute
Description: True if procedure should not be performed
FHIR Version: stu3
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 (ProcedureRequest) doNotPerform FHIR attribute
Description: Composite Request ID
FHIR Version: stu3
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 (ProcedureRequest) requisition FHIR attribute
Description: "occurrenceTiming" : { Timing },
FHIR Version: stu3
Attribute Type : Timing
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceTiming": Learn more about the (ProcedureRequest) occurrenceTiming FHIR attribute
Description: Encounter or Episode during which request was created
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": Learn more about the (ProcedureRequest) context FHIR attribute
Description: Identifiers assigned to this order
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (ProcedureRequest) identifier FHIR attribute
ProcedureRequest Example
{
"category": [
{
"text": "Diagnostics Procedure",
"coding": [
{
"code": "103693007",
"system": "http://snomed.info/sct",
"display": "Diagnostic procedure (procedure)"
}
]
}
],
"status": "completed",
"code": {
"coding": [
{
"code": "303653007",
"system": "http://snomed.info/sct",
"display": "Computed tomography of head"
}
]
},
"resourceType": "ProcedureRequest",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">To be added</div>"
},
"intent": "order",
"id": "example",
"subject": {
"reference": "Patient/example"
}
}ProcedureRequest Structure
{
"resourceType" : "ProcedureRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Identifiers assigned to this order
"definition" : [{ Reference(ActivityDefinition|PlanDefinition) }], // Protocol or definition
"basedOn" : [{ Reference(Any) }], // What request fulfills
"replaces" : [{ Reference(Any) }], // What request replaces
"requisition" : { Identifier }, // Composite Request ID
"status" : "<code>", // R! draft | active | suspended | completed | entered-in-error | cancelled
"intent" : "<code>", // R! proposal | plan | order +
"priority" : "<code>", // routine | urgent | asap | stat
"doNotPerform" : <boolean>, // True if procedure should not be performed
"category" : [{ CodeableConcept }], // Classification of procedure
"code" : { CodeableConcept }, // R! What is being requested/ordered
"subject" : { Reference(Patient|Group|Location|Device) }, // R! Individual the service is ordered for
"context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode during which request was created
// occurrence[x]: When procedure should occur. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
// asNeeded[x]: Preconditions for procedure or diagnostic. One of these 2:
"asNeededBoolean" : <boolean>,
"asNeededCodeableConcept" : { CodeableConcept },
"authoredOn" : "<dateTime>", // Date request signed
"requester" : { // Who/what is requesting procedure or diagnostic
"agent" : { Reference(Device|Practitioner|Organization) }, // R! Individual making the request
"onBehalfOf" : { Reference(Organization) } // Organization agent is acting for
},
"performerType" : { CodeableConcept }, // Performer role
"performer" : { Reference(Practitioner|Organization|Patient|Device|
RelatedPerson|HealthcareService) }, // Requested perfomer
"reasonCode" : [{ CodeableConcept }], // Explanation/Justification for test
"reasonReference" : [{ Reference(Condition|Observation) }], // Explanation/Justification for test
"supportingInfo" : [{ Reference(Any) }], // Additional clinical information
"specimen" : [{ Reference(Specimen) }], // Procedure Samples
"bodySite" : [{ CodeableConcept }], // Location on Body
"note" : [{ Annotation }], // Comments
"relevantHistory" : [{ Reference(Provenance) }] // Request provenance
}
ProcedureRequest Search Parameters
The following search parameters can be used to query ProcedureRequest resources. Just submit them like so:
https://api.1up.health/fhir/stu3/ProcedureRequest?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
authored | date | authoredOn |
based-on | reference | basedOn |
body-site | text | bodySite |
code | text | code |
context | reference | context |
definition | reference | definition |
encounter | reference | context |
identifier | text | identifier |
intent | text | intent |
occurrence | date | occurrence |
patient | reference | subject |
performer | reference | performer |
performer-type | text | performerType |
priority | text | priority |
replaces | reference | replaces |
requester | reference | requester.agent |
requisition | text | requisition |
specimen | reference | specimen |
status | text | status |
subject | reference | subject |
