Package org.hl7.fhir.dstu3.model

Class Procedure

java.lang.Object
org.hl7.fhir.dstu3.model.Base
org.hl7.fhir.dstu3.model.BaseResource
org.hl7.fhir.dstu3.model.Resource
org.hl7.fhir.dstu3.model.DomainResource
org.hl7.fhir.dstu3.model.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 a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
See Also:
Serialized Form

  • Field Details

    • identifier

      protected List<Identifier> identifier
      This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

    • definition

      protected List<Reference> definition
      A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.

    • definitionTarget

      protected List<Resource> definitionTarget
      The actual objects that are the target of the reference (A protocol, guideline, orderset or other definition that was 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

      protected List<Resource> 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

      protected List<Resource> 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

      protected Enumeration<Procedure.ProcedureStatus> status
      A code specifying the state of the procedure. Generally this will be in-progress or completed state.

    • notDone

      protected BooleanType notDone
      Set this to true if the record is saying that the procedure was NOT performed.

    • notDoneReason

      protected CodeableConcept notDoneReason
      A code indicating why the procedure was not performed.

    • category

      protected CodeableConcept 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

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

    • context

      protected Reference context
      The encounter during which the procedure was performed.

    • contextTarget

      protected Resource contextTarget
      The actual object that is the target of the reference (The encounter during which the procedure was performed.)

    • performed

      protected Type performed
      The date(time)/period over which 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.

    • performer

      protected List<Procedure.ProcedurePerformerComponent> 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

      protected Location 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

      protected List<CodeableConcept> reasonCode
      The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.

    • reasonReference

      protected List<Reference> reasonReference
      The condition that is the reason why the procedure was performed.

    • reasonReferenceTarget

      protected List<Resource> reasonReferenceTarget
      The actual objects that are the target of the reference (The condition that is the reason why the procedure was performed.)

    • bodySite

      protected List<CodeableConcept> bodySite
      Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

    • outcome

      protected CodeableConcept outcome
      The outcome of the procedure - did it resolve reasons for the procedure being performed?

    • report

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

    • reportTarget

      protected List<DiagnosticReport> reportTarget
      The actual objects that are the target of the reference (This could be a histology result, pathology report, surgical report, etc..)

    • complication

      protected List<CodeableConcept> 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

      protected List<Reference> complicationDetail
      Any complications that occurred during the procedure, or in the immediate post-performance period.

    • complicationDetailTarget

      protected List<Condition> 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

      protected List<CodeableConcept> followUp
      If the procedure required specific follow up - e.g. removal of sutures. The followup 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 about the procedure. E.g. the operative notes.

    • focalDevice

      protected List<Procedure.ProcedureFocalDeviceComponent> 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

      protected List<Reference> usedReference
      Identifies medications, devices and any other substance used as part of the procedure.

    • usedReferenceTarget

      protected List<Resource> 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

      protected List<CodeableConcept> usedCode
      Identifies coded items that were used as part of the procedure.

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: Date/Period the procedure was performed
      Type: date
      Path: Procedure.performed[x]

      See Also:
      Constant Field Values

    • DATE

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

      Description: Date/Period 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:
      Constant Field Values

    • 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:
      Constant Field Values

    • 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:
      Constant Field Values

    • 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:
      Constant Field Values

    • 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_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:
      Constant Field Values

    • 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: Search by encounter
      Type: reference
      Path: Procedure.context

      See Also:
      Constant Field Values

    • ENCOUNTER

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

      Description: Search by encounter
      Type: reference
      Path: Procedure.context

    • 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_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:
      Constant Field Values

    • 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:
      Constant Field Values

    • 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_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: Encounter or episode associated with the procedure
      Type: reference
      Path: Procedure.context

      See Also:
      Constant Field Values

    • CONTEXT

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

      Description: Encounter or episode associated with the procedure
      Type: reference
      Path: Procedure.context

    • INCLUDE_CONTEXT

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

    • SP_LOCATION

      public static final String SP_LOCATION
      Search parameter: location

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

      See Also:
      Constant Field Values

    • 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_DEFINITION

      public static final String SP_DEFINITION
      Search parameter: definition

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

      See Also:
      Constant Field Values

    • DEFINITION

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

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

    • INCLUDE_DEFINITION

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

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

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

      See Also:
      Constant Field Values

    • 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 | suspended | aborted | completed | entered-in-error | unknown
      Type: token
      Path: Procedure.status

      See Also:
      Constant Field Values

    • STATUS

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

      Description: preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
      Type: token
      Path: Procedure.status

  • Constructor Details

  • Method Details