Procedure

@POJOBoilerplate
class Procedure(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val note: LitSeq[Annotation], val partOf: LitSeq[Reference], val status: EVENT_STATUS, val report: LitSeq[Reference], val basedOn: LitSeq[Reference], val subject: Reference, val outcome: Option[CodeableConcept], val language: Option[LANGUAGES], val category: Option[CodeableConcept], val recorder: Option[Reference], val asserter: Option[Reference], val location: Option[Reference], val bodySite: LitSeq[CodeableConcept], val followUp: LitSeq[CodeableConcept], val usedCode: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val statusReason: Option[CodeableConcept], val performed: Option[PerformedChoice], val complication: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val usedReference: LitSeq[Reference], val instantiatesUri: LitSeq[UriStr], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val complicationDetail: LitSeq[Reference], val instantiatesCanonical: LitSeq[Canonical], val performer: LitSeq[Performer], val focalDevice: LitSeq[FocalDevice], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) 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.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
asserter
  • Individual who is making the procedure statement.
basedOn
  • A reference to a resource that contains details of the request for this procedure.
bodySite
  • Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
category
  • A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
code
  • The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
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.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
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.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
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.
language
  • The base language in which the resource is written.
location
  • The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Any other notes and comments about the procedure.
outcome
  • The outcome of the procedure - did it resolve the reasons for the procedure being performed?
partOf
  • A larger event of which this particular procedure is a component or step.
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.
performer
  • Limited to "real" people rather than equipment.
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.
recorder
  • Individual who recorded the record and takes responsibility for its content.
report
  • This could be a histology result, pathology report, surgical report, etc.
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.
subject
  • The person, animal or group on which the procedure was performed.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
usedCode
  • Identifies coded items that were used as part of the procedure.
usedReference
  • Identifies medications, devices and any other substance used as part of the procedure.
Constructor:

Introduces the fields code, note, partOf, status, report, basedOn, subject, outcome, category, recorder, asserter, location, bodySite, followUp, usedCode, encounter, identifier, reasonCode, statusReason, performed, complication, usedReference, instantiatesUri, reasonReference, complicationDetail, instantiatesCanonical, performer, focalDevice.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): Procedure

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[Procedure]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: Procedure <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: Procedure <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): Procedure

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: Procedure <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: Procedure <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): Procedure
Inherited from:
FHIRObject
def withField[T : LTag, Up >: Procedure <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: Procedure <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: Procedure <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): Procedure
Inherited from:
FHIRObject

Concrete fields

val asserter: Option[Reference]
val basedOn: LitSeq[Reference]
val bodySite: LitSeq[CodeableConcept]
val category: Option[CodeableConcept]
val code: Option[CodeableConcept]
val complication: LitSeq[CodeableConcept]
val complicationDetail: LitSeq[Reference]
override val contained: LitSeq[Resource]
val encounter: Option[Reference]
override val extension: LitSeq[Extension]
val followUp: LitSeq[CodeableConcept]
override val id: Option[String]
val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
val instantiatesCanonical: LitSeq[Canonical]
val instantiatesUri: LitSeq[UriStr]
override val language: Option[LANGUAGES]
val location: Option[Reference]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
val note: LitSeq[Annotation]
val outcome: Option[CodeableConcept]
val partOf: LitSeq[Reference]
val performer: LitSeq[Performer]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val reasonCode: LitSeq[CodeableConcept]
val reasonReference: LitSeq[Reference]
val recorder: Option[Reference]
val report: LitSeq[Reference]
val statusReason: Option[CodeableConcept]
val subject: Reference
override val text: Option[Narrative]
override val thisTypeName: String
val usedCode: LitSeq[CodeableConcept]
val usedReference: LitSeq[Reference]

Inherited fields

val companion: CompanionFor[Procedure]
Inherited from:
FHIRObject