Procedure - FHIR Resource (r4)
This Procedure Resource uses the
FHIR API standard for access and structure.
Validate an Procedure FHIR Resource (r4)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
asserter | false | Reference | # "asserter" : { Reference(Patient|RelatedPerson|Practitioner| |
basedOn | true | Reference | # A request for this procedure |
bodySite | true | CodeableConcept | # Target body sites |
category | false | CodeableConcept | # Classification of the procedure |
code | false | CodeableConcept | # Identification of the procedure |
complication | true | CodeableConcept | # Complication following the procedure |
complicationDetail | true | Reference | # A condition that is a result of the procedure |
encounter | false | Reference | # Encounter created as part of |
focalDevice | true | Data Type | # Manipulated, implanted, or removed device |
followUp | true | CodeableConcept | # Instructions for follow up |
identifier | true | Identifier | # External Identifiers for this procedure |
instantiatesCanonical | true | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | # "instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition| |
instantiatesUri | true | uri | # Instantiates external protocol or definition |
location | false | Reference | # Where the procedure happened |
note | true | Annotation | # Additional information about the procedure |
outcome | false | CodeableConcept | # The result of procedure |
partOf | true | Reference | # Part of referenced event |
performed[x] | false | dateTime|Period|string|Age|Range | #undefined |
performer | true | Data Type | # The people who performed the procedure |
reasonCode | true | CodeableConcept | # Coded reason procedure performed |
reasonReference | true | Reference | # "reasonReference" : [{ Reference(Condition|Observation|Procedure| |
recorder | false | Reference | # "recorder" : { Reference(Patient|RelatedPerson|Practitioner| |
report | true | Reference | # Any report resulting from the procedure |
status | false | code | # preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
statusReason | false | CodeableConcept | # Reason for current status |
subject | false | Reference | # Who the procedure was performed on |
usedCode | true | CodeableConcept | # Coded items used during the procedure |
usedReference | true | Reference | # Items used during procedure |
Procedure Example
{
"resourceType": "Procedure",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Routine Appendectomy</div>"
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "80146002",
"display": "Appendectomy (Procedure)"
}
],
"text": "Appendectomy"
},
"subject": {
"reference": "Patient/example"
},
"performedDateTime": "2013-04-05",
"recorder": {
"reference": "Practitioner/example",
"display": "Dr Cecil Surgeon"
},
"asserter": {
"reference": "Practitioner/example",
"display": "Dr Cecil Surgeon"
},
"performer": [
{
"actor": {
"reference": "Practitioner/example",
"display": "Dr Cecil Surgeon"
}
}
],
"reasonCode": [
{
"text": "Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"
}
],
"followUp": [
{
"text": "ROS 5 days - 2013-04-10"
}
],
"note": [
{
"text": "Routine Appendectomy. Appendix was inflamed and in retro-caecal position"
}
]
}
Procedure Structure
{
"resourceType" : "Procedure",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Identifiers for this procedure
"instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition|
Measure|OperationDefinition|Questionnaire) }], // Instantiates FHIR protocol or definition
"instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
"basedOn" : [{ Reference(CarePlan|ServiceRequest) }], // A request for this procedure
"partOf" : [{ Reference(Procedure|Observation|MedicationAdministration) }], // Part of referenced event
"status" : "<code>", // R! preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
"statusReason" : { CodeableConcept }, // Reason for current status
"category" : { CodeableConcept }, // Classification of the procedure
"code" : { CodeableConcept }, // Identification of the procedure
"subject" : { Reference(Patient|Group) }, // R! Who the procedure was performed on
"encounter" : { Reference(Encounter) }, // Encounter created as part of
// performed[x]: When the procedure was performed. One of these 5:
"performedDateTime" : "<dateTime>",
"performedPeriod" : { Period },
"performedString" : "<string>",
"performedAge" : { Age },
"performedRange" : { Range },
"recorder" : { Reference(Patient|RelatedPerson|Practitioner|
PractitionerRole) }, // Who recorded the procedure
"asserter" : { Reference(Patient|RelatedPerson|Practitioner|
PractitionerRole) }, // Person who asserts this procedure
"performer" : [{ // The people who performed the procedure
"function" : { CodeableConcept }, // Type of performance
"actor" : { Reference(Practitioner|PractitionerRole|Organization|Patient|
RelatedPerson|Device) }, // R! The reference to the practitioner
"onBehalfOf" : { Reference(Organization) } // Organization the device or practitioner was acting for
}],
"location" : { Reference(Location) }, // Where the procedure happened
"reasonCode" : [{ CodeableConcept }], // Coded reason procedure performed
"reasonReference" : [{ Reference(Condition|Observation|Procedure|
DiagnosticReport|DocumentReference) }], // The justification that the procedure was performed
"bodySite" : [{ CodeableConcept }], // Target body sites
"outcome" : { CodeableConcept }, // The result of procedure
"report" : [{ Reference(DiagnosticReport|DocumentReference|Composition) }], // Any report resulting from the procedure
"complication" : [{ CodeableConcept }], // Complication following the procedure
"complicationDetail" : [{ Reference(Condition) }], // A condition that is a result of the procedure
"followUp" : [{ CodeableConcept }], // Instructions for follow up
"note" : [{ Annotation }], // Additional information about the procedure
"focalDevice" : [{ // Manipulated, implanted, or removed device
"action" : { CodeableConcept }, // Kind of change to device
"manipulated" : { Reference(Device) } // R! Device that was changed
}],
"usedReference" : [{ Reference(Device|Medication|Substance) }], // Items used during procedure
"usedCode" : [{ CodeableConcept }] // Coded items used during the procedure
}
Procedure Search Parameters
The following search parameters can be used to query Procedure resources. Just submit them like so:
https://api.1up.health/fhir/r4/Procedure?query-param=queryvalue
Search Parameter | Field Type | Resource Fields Searched |
---|
based-on | reference | basedOn |
category | text | category |
code | text | code |
date | date | performed |
encounter | reference | encounter |
identifier | text | identifier |
instantiates-canonical | reference | instantiatesCanonical |
instantiates-uri | uri | instantiatesUri |
location | reference | location |
part-of | reference | partOf |
patient | reference | subject.where |
performer | reference | performer.actor |
reason-code | text | reasonCode |
reason-reference | reference | reasonReference |
status | text | status |
subject | reference | subject |