ProcedureRequest - FHIR Resource (stu3)


This ProcedureRequest Resource uses the FHIR API standard for access and structure.

Resource Attributes

AttributeField is listTypeDescription
asNeededBooleanfalseboolean "asNeededBoolean" : <boolean>,
asNeededCodeableConceptfalseCodeableConcept "asNeededCodeableConcept" : { CodeableConcept },
authoredOnfalsedateTime Date request signed
basedOntrueReference What request fulfills
bodySitetrueCodeableConcept Location on Body
categorytrueCodeableConcept Classification of procedure
codefalseCodeableConcept What is being requested/ordered
contextfalseReference Encounter or Episode during which request was created
definitiontrueReference Protocol or definition
doNotPerformfalseboolean True if procedure should not be performed
identifiertrueIdentifier Identifiers assigned to this order
intentfalsecode proposal | plan | order +
notetrueAnnotation Comments
occurrenceDateTimefalsedateTime "occurrenceDateTime" : "<dateTime>",
occurrencePeriodfalsePeriod "occurrencePeriod" : { Period },
occurrenceTimingfalseTiming "occurrenceTiming" : { Timing },
performerfalseReference "performer" : { Reference(Practitioner|Organization|Patient|Device|
performerTypefalseCodeableConcept Performer role
priorityfalsecode routine | urgent | asap | stat
reasonCodetrueCodeableConcept Explanation/Justification for test
reasonReferencetrueReference Explanation/Justification for test
relevantHistorytrueReference Request provenance
replacestrueReference What request replaces
requesterfalseData Type Who/what is requesting procedure or diagnostic
requisitionfalseIdentifier Composite Request ID
specimentrueReference Procedure Samples
statusfalsecode draft | active | suspended | completed | entered-in-error | cancelled
subjectfalseReference Individual the service is ordered for
supportingInfotrueReference Additional clinical information

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 the like so:

https://api.1up.health/fhir/stu3/ProcedureRequest?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authoreddateauthoredOn
based-onreferencebasedOn
body-sitetextbodySite
codetextcode
contextreferencecontext
definitionreferencedefinition
encounterreferencecontext
identifiertextidentifier
intenttextintent
occurrencedateoccurrence
patientreferencesubject
performerreferenceperformer
performer-typetextperformerType
prioritytextpriority
replacesreferencereplaces
requesterreferencerequester.agent
requisitiontextrequisition
specimenreferencespecimen
statustextstatus
subjectreferencesubject