Class Procedure

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Procedure extends DomainResource
An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.
See Also:
  • Field Details

    • identifier

      Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.
    • instantiatesCanonical

      The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
    • instantiatesUri

      The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
    • basedOn

      protected List<Reference> basedOn
      A reference to a resource that contains details of the request for this procedure.
    • basedOnTarget

      The actual objects that are the target of the reference (A reference to a resource that contains details of the request for this procedure.)
    • partOf

      protected List<Reference> partOf
      A larger event of which this particular procedure is a component or step.
    • partOfTarget

      The actual objects that are the target of the reference (A larger event of which this particular procedure is a component or step.)
    • status

      A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
    • statusReason

      Captures the reason for the current state of the procedure.
    • category

      A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
    • code

      protected CodeableConcept code
      The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
    • subject

      protected Reference subject
      The person, animal or group on which the procedure was performed.
    • subjectTarget

      The actual object that is the target of the reference (The person, animal or group on which the procedure was performed.)
    • encounter

      protected Reference encounter
      The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.
    • encounterTarget

      The actual object that is the target of the reference (The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.)
    • performed

      protected Type performed
      Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
    • recorder

      protected Reference recorder
      Individual who recorded the record and takes responsibility for its content.
    • recorderTarget

      The actual object that is the target of the reference (Individual who recorded the record and takes responsibility for its content.)
    • asserter

      protected Reference asserter
      Individual who is making the procedure statement.
    • asserterTarget

      The actual object that is the target of the reference (Individual who is making the procedure statement.)
    • performer

      Limited to "real" people rather than equipment.
    • location

      protected Reference location
      The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
    • locationTarget

      The actual object that is the target of the reference (The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.)
    • reasonCode

      The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.
    • reasonReference

      The justification of why the procedure was performed.
    • reasonReferenceTarget

      The actual objects that are the target of the reference (The justification of why the procedure was performed.)
    • bodySite

      Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
    • outcome

      The outcome of the procedure - did it resolve the reasons for the procedure being performed?
    • report

      protected List<Reference> report
      This could be a histology result, pathology report, surgical report, etc.
    • reportTarget

      The actual objects that are the target of the reference (This could be a histology result, pathology report, surgical report, etc.)
    • complication

      Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.
    • complicationDetail

      Any complications that occurred during the procedure, or in the immediate post-performance period.
    • complicationDetailTarget

      The actual objects that are the target of the reference (Any complications that occurred during the procedure, or in the immediate post-performance period.)
    • followUp

      If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.
    • note

      protected List<Annotation> note
      Any other notes and comments about the procedure.
    • focalDevice

      A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
    • usedReference

      Identifies medications, devices and any other substance used as part of the procedure.
    • usedReferenceTarget

      The actual objects that are the target of the reference (Identifies medications, devices and any other substance used as part of the procedure.)
    • usedCode

      Identifies coded items that were used as part of the procedure.
    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: When the procedure was performed
      Type: date
      Path: Procedure.performed[x]

      See Also:
    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: When the procedure was performed
      Type: date
      Path: Procedure.performed[x]

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: A unique identifier for a procedure
      Type: token
      Path: Procedure.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: A unique identifier for a procedure
      Type: token
      Path: Procedure.identifier

    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: A code to identify a procedure
      Type: token
      Path: Procedure.code

      See Also:
    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: A code to identify a procedure
      Type: token
      Path: Procedure.code

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter: performer

      Description: The reference to the practitioner
      Type: reference
      Path: Procedure.performer.actor

      See Also:
    • PERFORMER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
      Fluent Client search parameter constant for performer

      Description: The reference to the practitioner
      Type: reference
      Path: Procedure.performer.actor

    • INCLUDE_PERFORMER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:performer".
    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Search by subject
      Type: reference
      Path: Procedure.subject

      See Also:
    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: Search by subject
      Type: reference
      Path: Procedure.subject

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:subject".
    • SP_INSTANTIATES_CANONICAL

      public static final String SP_INSTANTIATES_CANONICAL
      Search parameter: instantiates-canonical

      Description: Instantiates FHIR protocol or definition
      Type: reference
      Path: Procedure.instantiatesCanonical

      See Also:
    • INSTANTIATES_CANONICAL

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL
      Fluent Client search parameter constant for instantiates-canonical

      Description: Instantiates FHIR protocol or definition
      Type: reference
      Path: Procedure.instantiatesCanonical

    • INCLUDE_INSTANTIATES_CANONICAL

      public static final ca.uhn.fhir.model.api.Include INCLUDE_INSTANTIATES_CANONICAL
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:instantiates-canonical".
    • SP_PART_OF

      public static final String SP_PART_OF
      Search parameter: part-of

      Description: Part of referenced event
      Type: reference
      Path: Procedure.partOf

      See Also:
    • PART_OF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF
      Fluent Client search parameter constant for part-of

      Description: Part of referenced event
      Type: reference
      Path: Procedure.partOf

    • INCLUDE_PART_OF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:part-of".
    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: Encounter created as part of
      Type: reference
      Path: Procedure.encounter

      See Also:
    • ENCOUNTER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
      Fluent Client search parameter constant for encounter

      Description: Encounter created as part of
      Type: reference
      Path: Procedure.encounter

    • INCLUDE_ENCOUNTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:encounter".
    • SP_REASON_CODE

      public static final String SP_REASON_CODE
      Search parameter: reason-code

      Description: Coded reason procedure performed
      Type: token
      Path: Procedure.reasonCode

      See Also:
    • REASON_CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_CODE
      Fluent Client search parameter constant for reason-code

      Description: Coded reason procedure performed
      Type: token
      Path: Procedure.reasonCode

    • SP_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: A request for this procedure
      Type: reference
      Path: Procedure.basedOn

      See Also:
    • BASED_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
      Fluent Client search parameter constant for based-on

      Description: A request for this procedure
      Type: reference
      Path: Procedure.basedOn

    • INCLUDE_BASED_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:based-on".
    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Search by subject - a patient
      Type: reference
      Path: Procedure.subject

      See Also:
    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: Search by subject - a patient
      Type: reference
      Path: Procedure.subject

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:patient".
    • SP_REASON_REFERENCE

      public static final String SP_REASON_REFERENCE
      Search parameter: reason-reference

      Description: The justification that the procedure was performed
      Type: reference
      Path: Procedure.reasonReference

      See Also:
    • REASON_REFERENCE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REASON_REFERENCE
      Fluent Client search parameter constant for reason-reference

      Description: The justification that the procedure was performed
      Type: reference
      Path: Procedure.reasonReference

    • INCLUDE_REASON_REFERENCE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_REASON_REFERENCE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:reason-reference".
    • SP_LOCATION

      public static final String SP_LOCATION
      Search parameter: location

      Description: Where the procedure happened
      Type: reference
      Path: Procedure.location

      See Also:
    • LOCATION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
      Fluent Client search parameter constant for location

      Description: Where the procedure happened
      Type: reference
      Path: Procedure.location

    • INCLUDE_LOCATION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:location".
    • SP_INSTANTIATES_URI

      public static final String SP_INSTANTIATES_URI
      Search parameter: instantiates-uri

      Description: Instantiates external protocol or definition
      Type: uri
      Path: Procedure.instantiatesUri

      See Also:
    • INSTANTIATES_URI

      public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI
      Fluent Client search parameter constant for instantiates-uri

      Description: Instantiates external protocol or definition
      Type: uri
      Path: Procedure.instantiatesUri

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

      Description: Classification of the procedure
      Type: token
      Path: Procedure.category

      See Also:
    • CATEGORY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
      Fluent Client search parameter constant for category

      Description: Classification of the procedure
      Type: token
      Path: Procedure.category

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
      Type: token
      Path: Procedure.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
      Type: token
      Path: Procedure.status

  • Constructor Details

  • Method Details