Procedure - FHIR Resource (r4)


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

Validate an Procedure FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
asserterfalseReference# "asserter" : { Reference(Patient|RelatedPerson|Practitioner|
basedOntrueReference# A request for this procedure
bodySitetrueCodeableConcept# Target body sites
categoryfalseCodeableConcept# Classification of the procedure
codefalseCodeableConcept# Identification of the procedure
complicationtrueCodeableConcept# Complication following the procedure
complicationDetailtrueReference# A condition that is a result of the procedure
encounterfalseReference# Encounter created as part of
focalDevicetrueData Type# Manipulated, implanted, or removed device
followUptrueCodeableConcept# Instructions for follow up
identifiertrueIdentifier# External Identifiers for this procedure
instantiatesCanonicaltruecanonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)# "instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition|
instantiatesUritrueuri# Instantiates external protocol or definition
locationfalseReference# Where the procedure happened
notetrueAnnotation# Additional information about the procedure
outcomefalseCodeableConcept# The result of procedure
partOftrueReference# Part of referenced event
performed[x]falsedateTime|Period|string|Age|Range#undefined
performertrueData Type# The people who performed the procedure
reasonCodetrueCodeableConcept# Coded reason procedure performed
reasonReferencetrueReference# "reasonReference" : [{ Reference(Condition|Observation|Procedure|
recorderfalseReference# "recorder" : { Reference(Patient|RelatedPerson|Practitioner|
reporttrueReference# Any report resulting from the procedure
statusfalsecode# preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
statusReasonfalseCodeableConcept# Reason for current status
subjectfalseReference# Who the procedure was performed on
usedCodetrueCodeableConcept# Coded items used during the procedure
usedReferencetrueReference# 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 ParameterField TypeResource Fields Searched
based-onreferencebasedOn
categorytextcategory
codetextcode
datedateperformed
encounterreferenceencounter
identifiertextidentifier
instantiates-canonicalreferenceinstantiatesCanonical
instantiates-uriuriinstantiatesUri
locationreferencelocation
part-ofreferencepartOf
patientreferencesubject.where
performerreferenceperformer.actor
reason-codetextreasonCode
reason-referencereferencereasonReference
statustextstatus
subjectreferencesubject