Procedure - FHIR Resource (r4)
This Procedure Resource uses the FHIR API standard for access and structure.
Validate an Procedure FHIR Resource (r4)
Procedure Attributes
AttributeField is listTypeDescription
Description: External Identifiers for this procedure
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": Learn more about the (Procedure) identifier FHIR attribute
Description: "instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition|
FHIR Version: r4
Attribute Type : canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesCanonical": Learn more about the (Procedure) 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 (Procedure) instantiatesUri FHIR attribute
Description: A request for this procedure
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 (Procedure) basedOn FHIR attribute
Description: Part of referenced event
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:
"partOf": Learn more about the (Procedure) partOf FHIR attribute
Description: preparation | in-progress | not-done | on-hold | stopped | 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": "completed"Learn more about the (Procedure) status FHIR attribute
Description: Reason for current status
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:
"statusReason": Learn more about the (Procedure) statusReason FHIR attribute
Description: Classification of the procedure
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:
"category": Learn more about the (Procedure) category FHIR attribute
Description: Identification of the procedure
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://snomed.info/sct",
"code": "80146002",
"display": "Appendectomy (Procedure)"
}
],
"text": "Appendectomy"
}Learn more about the (Procedure) code FHIR attribute
Description: Who the procedure was performed on
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 (Procedure) subject FHIR attribute
Description: Encounter created as part of
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": Learn more about the (Procedure) encounter FHIR attribute
Description:
FHIR Version: r4
Attribute Type : dateTime|Period|string|Age|Range
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performed[x]": Learn more about the (Procedure) performed[x] FHIR attribute
Description: "recorder" : { Reference(Patient|RelatedPerson|Practitioner|
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:
"recorder": {
"reference": "Practitioner/example",
"display": "Dr Cecil Surgeon"
}Learn more about the (Procedure) recorder FHIR attribute
Description: "asserter" : { Reference(Patient|RelatedPerson|Practitioner|
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:
"asserter": {
"reference": "Practitioner/example",
"display": "Dr Cecil Surgeon"
}Learn more about the (Procedure) asserter FHIR attribute
Description: The people who performed the procedure
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": [
{
"actor": {
"reference": "Practitioner/example",
"display": "Dr Cecil Surgeon"
}
}
]Learn more about the (Procedure) performer FHIR attribute
Description: Where the procedure happened
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:
"location": Learn more about the (Procedure) location FHIR attribute
Description: Coded reason procedure performed
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": [
{
"text": "Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"
}
]Learn more about the (Procedure) reasonCode FHIR attribute
Description: "reasonReference" : [{ Reference(Condition|Observation|Procedure|
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 (Procedure) reasonReference FHIR attribute
Description: Target body sites
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 (Procedure) bodySite FHIR attribute
Description: The result of procedure
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:
"outcome": Learn more about the (Procedure) outcome FHIR attribute
Description: Any report resulting from the procedure
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:
"report": Learn more about the (Procedure) report FHIR attribute
Description: Complication following the procedure
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:
"complication": Learn more about the (Procedure) complication FHIR attribute
Description: A condition that is a result of the procedure
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:
"complicationDetail": Learn more about the (Procedure) complicationDetail FHIR attribute
Description: Instructions for follow up
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:
"followUp": [
{
"text": "ROS 5 days - 2013-04-10"
}
]Learn more about the (Procedure) followUp FHIR attribute
Description: Additional information about the procedure
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": "Routine Appendectomy. Appendix was inflamed and in retro-caecal position"
}
]Learn more about the (Procedure) note FHIR attribute
Description: Manipulated, implanted, or removed device
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"focalDevice": Learn more about the (Procedure) focalDevice FHIR attribute
Description: Items used during procedure
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:
"usedReference": Learn more about the (Procedure) usedReference FHIR attribute
Description: Coded items used during the procedure
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:
"usedCode": Learn more about the (Procedure) usedCode FHIR attribute
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 |
