Procedure - FHIR Resource (dstu2)
This Procedure Resource uses the FHIR API standard for access and structure.
Validate an Procedure FHIR Resource (dstu2)
Procedure Attributes
AttributeField is listTypeDescription
Description: in-progress | aborted | completed | entered-in-error
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (Procedure) status FHIR attribute
Description: Identification of the procedure
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": Learn more about the (Procedure) code FHIR attribute
Description: The people who performed the procedure
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": Learn more about the (Procedure) performer FHIR attribute
Description: Target body sites
FHIR Version: dstu2
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: Who the procedure was performed on
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": Learn more about the (Procedure) subject FHIR attribute
Description: Classification of the procedure
FHIR Version: dstu2
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: Complication following the procedure
FHIR Version: dstu2
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: Where the procedure happened
FHIR Version: dstu2
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: "performedPeriod" : { Period },
FHIR Version: dstu2
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performedPeriod": Learn more about the (Procedure) performedPeriod FHIR attribute
Description: True if procedure was not performed as scheduled
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"notPerformed": Learn more about the (Procedure) notPerformed FHIR attribute
Description: Items used during procedure
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"used": Learn more about the (Procedure) used FHIR attribute
Description: Device changed in procedure
FHIR Version: dstu2
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: C? Reason procedure was not performed
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonNotPerformed": Learn more about the (Procedure) reasonNotPerformed FHIR attribute
Description: Any report resulting from the procedure
FHIR Version: dstu2
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: The encounter associated with the procedure
FHIR Version: dstu2
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: External Identifiers for this procedure
FHIR Version: dstu2
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: "reasonReference" : { Reference(Condition) },
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (Procedure) reasonReference FHIR attribute
Description: Additional information about the procedure
FHIR Version: dstu2
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"notes": Learn more about the (Procedure) notes FHIR attribute
Description: Instructions for follow up
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"followUp": Learn more about the (Procedure) followUp FHIR attribute
Description: "request" : { Reference(CarePlan|DiagnosticOrder|ProcedureRequest|
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"request": Learn more about the (Procedure) request FHIR attribute
Description: "performedDateTime" : "<dateTime>",
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performedDateTime": Learn more about the (Procedure) performedDateTime FHIR attribute
Description: "reasonCodeableConcept" : { CodeableConcept },
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCodeableConcept": Learn more about the (Procedure) reasonCodeableConcept FHIR attribute
Description: The result of procedure
FHIR Version: dstu2
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
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
"subject" : { Reference(Patient|Group) }, // R! Who the procedure was performed on
"status" : "<code>", // R! in-progress | aborted | completed | entered-in-error
"category" : { CodeableConcept }, // Classification of the procedure
"code" : { CodeableConcept }, // R! Identification of the procedure
"notPerformed" : <boolean>, // True if procedure was not performed as scheduled
"reasonNotPerformed" : [{ CodeableConcept }], // C? Reason procedure was not performed
"bodySite" : [{ CodeableConcept }], // Target body sites
// reason[x]: Reason procedure performed. One of these 2:
"reasonCodeableConcept" : { CodeableConcept },
"reasonReference" : { Reference(Condition) },
"performer" : [{ // The people who performed the procedure
"actor" : { Reference(Practitioner|Organization|Patient|RelatedPerson) }, // The reference to the practitioner
"role" : { CodeableConcept } // The role the actor was in
}],
// performed[x]: Date/Period the procedure was performed. One of these 2:
"performedDateTime" : "<dateTime>",
"performedPeriod" : { Period },
"encounter" : { Reference(Encounter) }, // The encounter associated with the procedure
"location" : { Reference(Location) }, // Where the procedure happened
"outcome" : { CodeableConcept }, // The result of procedure
"report" : [{ Reference(DiagnosticReport) }], // Any report resulting from the procedure
"complication" : [{ CodeableConcept }], // Complication following the procedure
"followUp" : [{ CodeableConcept }], // Instructions for follow up
"request" : { Reference(CarePlan|DiagnosticOrder|ProcedureRequest|
ReferralRequest) }, // A request for this procedure
"notes" : [{ Annotation }], // Additional information about the procedure
"focalDevice" : [{ // Device changed in procedure
"action" : { CodeableConcept }, // Kind of change to device
"manipulated" : { Reference(Device) } // R! Device that was changed
}],
"used" : [{ Reference(Device|Medication|Substance) }] // Items used during 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/dstu2/Procedure?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
code | text | code |
date | date | performed[x] |
encounter | reference | encounter |
identifier | text | identifier |
location | reference | location |
patient | reference | subject |
performer | reference | performer.actor |
subject | reference | subject |
