Procedure - FHIR Resource (stu3)


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

Validate an Procedure FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
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
contextfalseReference Encounter or episode associated with the procedure
definitiontrueReference "definition" : [{ Reference(PlanDefinition|ActivityDefinition|
focalDevicetrueData Type Device changed in procedure
followUptrueCodeableConcept Instructions for follow up
identifiertrueIdentifier External Identifiers for this procedure
locationfalseReference Where the procedure happened
notDonefalseboolean True if procedure was not performed as scheduled
notDoneReasonfalseCodeableConcept C? Reason procedure was not performed
notetrueAnnotation Additional information about the procedure
outcomefalseCodeableConcept The result of procedure
partOftrueReference Part of referenced event
performedDateTimefalsedateTime "performedDateTime" : "<dateTime>",
performedPeriodfalsePeriod "performedPeriod" : { Period },
performertrueData Type The people who performed the procedure
reasonCodetrueCodeableConcept Coded reason procedure performed
reasonReferencetrueReference Condition that is the reason the procedure performed
reporttrueReference Any report resulting from the procedure
statusfalsecode preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
subjectfalseReference Who the procedure was performed on
usedCodetrueCodeableConcept Coded items used during the procedure
usedReferencetrueReference Items used during procedure

Procedure Example

{
  "status": "completed",
  "followUp": [
    {
      "text": "ROS 5 days  - 2013-04-10"
    }
  ],
  "code": {
    "text": "Appendectomy",
    "coding": [
      {
        "code": "80146002",
        "system": "http://snomed.info/sct",
        "display": "Appendectomy (Procedure)"
      }
    ]
  },
  "resourceType": "Procedure",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Routine Appendectomy</div>"
  },
  "note": [
    {
      "text": "Routine Appendectomy. Appendix was inflamed and in retro-caecal position"
    }
  ],
  "performedDateTime": "2013-04-05",
  "performer": [
    {
      "actor": {
        "display": "Dr Cecil Surgeon",
        "reference": "Practitioner/example"
      }
    }
  ],
  "reasonCode": [
    {
      "text": "Generalized abdominal pain 24 hours. Localized in RIF with rebound and guarding"
    }
  ],
  "id": "example",
  "subject": {
    "reference": "Patient/example"
  }
}

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
  "definition" : [{ Reference(PlanDefinition|ActivityDefinition|
   HealthcareService) }], // Instantiates protocol or definition
  "basedOn" : [{ Reference(CarePlan|ProcedureRequest|ReferralRequest) }], // A request for this procedure
  "partOf" : [{ Reference(Procedure|Observation|MedicationAdministration) }], // Part of referenced event
  "status" : "<code>", // R!  preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
  "notDone" : <boolean>, // True if procedure was not performed as scheduled
  "notDoneReason" : { CodeableConcept }, // C? Reason procedure was not performed
  "category" : { CodeableConcept }, // Classification of the procedure
  "code" : { CodeableConcept }, // Identification of the procedure
  "subject" : { Reference(Patient|Group) }, // R!  Who the procedure was performed on
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or episode associated with the procedure
  // performed[x]: Date/Period the procedure was performed. One of these 2:
  "performedDateTime" : "<dateTime>",
  "performedPeriod" : { Period },
  "performer" : [{ // The people who performed the procedure
    "role" : { CodeableConcept }, // The role the actor was in
    "actor" : { Reference(Practitioner|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) }], // Condition that is the reason the procedure performed
  "bodySite" : [{ CodeableConcept }], // Target body sites
  "outcome" : { CodeableConcept }, // The result of procedure
  "report" : [{ Reference(DiagnosticReport) }], // 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" : [{ // Device changed in procedure
    "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 the like so:

https://api.1up.health/fhir/stu3/Procedure?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
based-onreferencebasedOn
categorytextcategory
codetextcode
contextreferencecontext
datedateperformed
definitionreferencedefinition
encounterreferencecontext
identifiertextidentifier
locationreferencelocation
part-ofreferencepartOf
patientreferencesubject
performerreferenceperformer.actor
statustextstatus
subjectreferencesubject