FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

9.3 Resource Procedure - Content

Patient Care Work Group Maturity Level : 3   Trial Use Compartments : Encounter , Patient , Practitioner , RelatedPerson

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.

9.3.1 Scope and Usage

Procedure is one of the event resources in the FHIR workflow specification.

This resource is used to record the details of current and historical procedures performed on a patient. A procedure is an activity that is performed with or on a patient as part of the provision of care. Examples include surgical procedures, diagnostic procedures, endoscopic procedures, biopsies, counseling, physiotherapy, exercise, etc. Procedures may be performed by a healthcare professional, a friend or relative or in some cases by the patient themselves.

This resource provides summary information about the occurrence of the procedure and is not intended to provide real-time snapshots of a procedure as it unfolds, though for long-running procedures such as psychotherapy, it could represent summary level information about overall progress. The creation of a resource to support detailed real-time procedure information awaits the identification of a specific implementation use-case to share such information.

9.3.2 Boundaries and Relationships

The Procedure resource should not be used to capture an event if a more specific resource already exists - i.e. immunizations , drug administrations and communications . The boundary between determining whether an action is a Procedure (training or counseling) as opposed to a Communication is based on whether there's a specific intent to change the mind-set of the patient. Mere disclosure of information would be considered a Communication. A process that involves verification of the patient's comprehension or to change the patient's mental state would be a Procedure.

Note that many diagnostic processes are procedures that generate Observations and DiagnosticReports . In many cases, such an observation does not require an explicit representation of the procedure used to create the observation, but where there are details of interest about how the diagnostic procedure was performed, the procedure resource is used to describe the activity.

Some diagnostic procedures may might not have a Procedure record. The Procedure record is only necessary when there is a need to capture information about the physical intervention that was performed to capture the diagnostic information (e.g. anesthetic, incision, scope size, etc.)

This resource is referenced by AdverseEvent , Appointment , ChargeItem , Claim , ClinicalImpression , DeviceUseStatement , Encounter , ExplanationOfBenefit , Flag , ImagingStudy , MedicationAdministration , MedicationDispense , MedicationStatement , Observation and QuestionnaireResponse

9.3.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . Procedure I TU DomainResource An action that is being or was performed on a patient
+ Reason not done is only permitted if notDone indicator is true Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier External Identifiers for this procedure
. . definition . instantiates Σ 0..* Reference ( PlanDefinition | ActivityDefinition | HealthcareService uri ) Instantiates protocol or definition
. . . basedOn Σ 0..* Reference ( CarePlan | ProcedureRequest | ReferralRequest ServiceRequest ) A request for this procedure
. . . partOf Σ 0..* Reference ( Procedure | Observation | MedicationAdministration ) Part of referenced event
. . . status ?! Σ 1..1 code preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown
EventStatus ( Required )
. . notDone ?! Σ 0..1 boolean True if procedure was not performed as scheduled . notDoneReason statusReason Σ I 0..1 CodeableConcept Reason procedure was not performed for current status
Procedure Not Performed Reason (SNOMED-CT) ( Example )
. . . category Σ 0..1 CodeableConcept Classification of the procedure
Procedure Category Codes (SNOMED CT) ( Example )
. . . code Σ 0..1 CodeableConcept Identification of the procedure
Procedure Codes (SNOMED CT) ( Example )
. . . subject Σ 1..1 Reference ( Patient | Group ) Who the procedure was performed on
. . . context Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or episode associated with the procedure
. . . performed[x] Σ 0..1 Date/Period When the procedure was performed
. . . . performedDateTime dateTime
. . . . performedPeriod Period
. . . . performedString string
.... performedAge Age
.... performedRange Range
... recorder Σ 0..1 Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole ) Who recorded the procedure
... asserter Σ 0..1 Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole ) Person who asserts this procedure
. . . performer Σ 0..* BackboneElement The people who performed the procedure
. . . . role Σ 0..1 CodeableConcept The role the actor was in
Procedure Performer Role Codes ( Example )
. . . . actor Σ 1..1 Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device ) The reference to the practitioner
. . . . onBehalfOf 0..1 Reference ( Organization ) Organization the device or practitioner was acting for
. . . location Σ 0..1 Reference ( Location ) Where the procedure happened
. . . reasonCode Σ 0..* CodeableConcept Coded reason procedure performed
Procedure Reason Codes ( Example )
. . . reasonReference Σ 0..* Reference ( Condition | Observation | Procedure | DiagnosticReport | DocumentReference ) Condition The justification that is the reason the procedure was performed
. . . bodySite Σ 0..* CodeableConcept Target body sites
SNOMED CT Body Structures ( Example )
. . . outcome Σ 0..1 CodeableConcept The result of procedure
Procedure Outcome Codes (SNOMED CT) ( Example )
. . . report 0..* Reference ( DiagnosticReport | DocumentReference | Composition ) Any report resulting from the procedure
. . . complication 0..* CodeableConcept Complication following the procedure
Condition/Problem/Diagnosis Codes ( Example )
. . . complicationDetail 0..* Reference ( Condition ) A condition that is that is a result of the procedure
. . . followUp 0..* CodeableConcept Instructions for follow up
Procedure Follow up Codes (SNOMED CT) ( Example )
. . . note 0..* Annotation Additional information about the procedure
. . . focalDevice 0..* BackboneElement Device changed in procedure Manipulated, implanted, or removed device
. . . . action 0..1 CodeableConcept Kind of change to device
Procedure Device Action Codes ( Preferred )
. . . . manipulated 1..1 Reference ( Device ) Device that was changed
. . . usedReference 0..* Reference ( Device | Medication | Substance ) Items used during procedure
. . . usedCode 0..* CodeableConcept Coded items used during the procedure
FHIR Device Types ( Example )

doco Documentation for this format

UML Diagram ( Legend )

Procedure ( DomainResource ) This records Business identifiers associated with assigned to this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the performer or other systems which remain constant as the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation) updated and propagates from server to server identifier : Identifier [0..*] A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure definition instantiates : Reference uri [0..*] PlanDefinition | ActivityDefinition | HealthcareService A reference to a resource that contains details of the request for this procedure basedOn : Reference [0..*] « CarePlan | ProcedureRequest | ReferralRequest ServiceRequest » A larger event of which this particular procedure is a component or step partOf : Reference [0..*] « Procedure | Observation | MedicationAdministration » A code specifying the state of the procedure. Generally this will be in-progress or completed state (this element modifies the meaning of other elements) status : code [1..1] « A code specifying the state of the procedure. (Strength=Required) EventStatus ! » Set this to true if the record is saying that Captures the procedure was NOT performed (this element modifies reason for the meaning current state of other elements) notDone : boolean [0..1] A code indicating why the procedure was not performed notDoneReason statusReason : CodeableConcept [0..1] « A code that identifies the reason a procedure was not performed. (Strength=Example) Procedure Not Performed Reaso... ?? » A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure") "Surgical Procedure") category : CodeableConcept [0..1] « A code that classifies a procedure for searching, sorting and display purposes. (Strength=Example) Procedure Category Codes (SNO... ?? » The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy") "Laparoscopic Appendectomy") code : CodeableConcept [0..1] « A code to identify a specific procedure . (Strength=Example) Procedure Codes (SNOMED CT) ?? » The person, animal or group on which the procedure was performed subject : Reference [1..1] « Patient | Group » The encounter during which the procedure was performed context : Reference [0..1] « Encounter | EpisodeOfCare » The date(time)/period over which 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 performed[x] : Type [0..1] « dateTime | Period | string | Age | Range » Individual who recorded the record and takes responsibility for its content recorder : Reference [0..1] « Patient | RelatedPerson | Practitioner | PractitionerRole » Individual who is making the procedure statement asserter : Reference [0..1] « Patient | RelatedPerson | Practitioner | PractitionerRole » The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant location : Reference [0..1] « Location » The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text reasonCode : CodeableConcept [0..*] « A code that identifies the reason a procedure is required. (Strength=Example) Procedure Reason ?? » The condition that is the reason justification of why the procedure was performed reasonReference : Reference [0..*] « Condition | Observation | Procedure | DiagnosticReport | DocumentReference » Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion bodySite : CodeableConcept [0..*] « Codes describing anatomical locations. May include laterality. (Strength=Example) SNOMED CT Body Structures ?? » The outcome of the procedure - did it resolve reasons for the procedure being performed? outcome : CodeableConcept [0..1] « An outcome of a procedure - whether it was resolved or otherwise. (Strength=Example) Procedure Outcome Codes (SNOM... ?? » This could be a histology result, pathology report, surgical report, etc. etc report : Reference [0..*] « DiagnosticReport | DocumentReference | Composition » 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 complication : CodeableConcept [0..*] « Codes describing complications that resulted from a procedure. (Strength=Example) Condition/Problem/Diagnosis ?? » Any complications that occurred during the procedure, or in the immediate post-performance period complicationDetail : Reference [0..*] « Condition » 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 followUp : CodeableConcept [0..*] « Specific follow up required for a procedure e.g. removal of sutures. (Strength=Example) Procedure Follow up Codes (SN... ?? » Any other notes and comments about the procedure. E.g. the operative notes procedure note : Annotation [0..*] Identifies medications, devices and any other substance used as part of the procedure usedReference : Reference [0..*] « Device | Medication | Substance » Identifies coded items that were used as part of the procedure usedCode : CodeableConcept [0..*] « Codes describing items used during a procedure (Strength=Example) FHIR Device Types ?? » Performer For example: surgeon, anaethetist, endoscopist role : CodeableConcept [0..1] « A code that identifies the role of a performer of the procedure. (Strength=Example) Procedure Performer Role ?? » The practitioner who was involved in the procedure actor : Reference [1..1] « Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device » The organization the device or practitioner was acting on behalf of onBehalfOf : Reference [0..1] « Organization » FocalDevice The kind of change that happened to the device during the procedure action : CodeableConcept [0..1] « A kind of change that happened to the device during the procedure. (Strength=Preferred) Procedure Device Action ? » The device that was manipulated (changed) during the procedure manipulated : Reference [1..1] « Device » Limited to 'real' people rather than equipment performer [0..*] 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 focalDevice [0..*]

XML Template 

<

<Procedure xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <|
   </definition>
 <</basedOn>

 <identifier><!-- 0..* Identifier External Identifiers for this procedure --></identifier>
 <instantiates value="[uri]"/><!-- 0..* Instantiates protocol or definition -->
 <basedOn><!-- 0..* Reference(CarePlan|ServiceRequest) A request for this procedure --></basedOn>

 <partOf><!-- 0..* Reference(Procedure|Observation|MedicationAdministration) Part of referenced event --></partOf>
 <
 <
 <</notDoneReason>

 <status value="[code]"/><!-- 1..1 preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown -->
 <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason>

 <category><!-- 0..1 CodeableConcept Classification of the procedure --></category>
 <code><!-- 0..1 CodeableConcept Identification of the procedure --></code>
 <subject><!-- 1..1 Reference(Patient|Group) Who the procedure was performed on --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or episode associated with the procedure --></context>
 <</performed[x]>

 <performed[x]><!-- 0..1 dateTime|Period|string|Age|Range When the procedure was performed --></performed[x]>
 <recorder><!-- 0..1 Reference(Patient|RelatedPerson|Practitioner|
   PractitionerRole) Who recorded the procedure --></recorder>

 <asserter><!-- 0..1 Reference(Patient|RelatedPerson|Practitioner|
   PractitionerRole) Person who asserts this procedure --></asserter>
 <performer>  <!-- 0..* The people who performed the procedure -->
  <role><!-- 0..1 CodeableConcept The role the actor was in --></role>
  <|
    </actor>

  <actor><!-- 1..1 Reference(Practitioner|PractitionerRole|Organization|Patient|
    RelatedPerson|Device) The reference to the practitioner --></actor>
  <onBehalfOf><!-- 0..1 Reference(Organization) Organization the device or practitioner was acting for --></onBehalfOf>
 </performer>
 <location><!-- 0..1 Reference(Location) Where the procedure happened --></location>
 <reasonCode><!-- 0..* CodeableConcept Coded reason procedure performed --></reasonCode>
 <</reasonReference>

 <reasonReference><!-- 0..* Reference(Condition|Observation|Procedure|
   DiagnosticReport|DocumentReference) The justification that the procedure was performed --></reasonReference>
 <bodySite><!-- 0..* CodeableConcept Target body sites --></bodySite>
 <outcome><!-- 0..1 CodeableConcept The result of procedure --></outcome>
 <</report>

 <report><!-- 0..* Reference(DiagnosticReport|DocumentReference|Composition) Any report resulting from the procedure --></report>

 <complication><!-- 0..* CodeableConcept Complication following the procedure --></complication>
 <</complicationDetail>

 <complicationDetail><!-- 0..* Reference(Condition) A condition that is a result of the procedure --></complicationDetail>

 <followUp><!-- 0..* CodeableConcept Instructions for follow up --></followUp>
 <</note>
 <

 <note><!-- 0..* Annotation Additional information about the procedure --></note>
 <focalDevice>  <!-- 0..* Manipulated, implanted, or removed device -->

  <action><!-- 0..1 CodeableConcept Kind of change to device --></action>
  <manipulated><!-- 1..1 Reference(Device) Device that was changed --></manipulated>
 </focalDevice>
 <usedReference><!-- 0..* Reference(Device|Medication|Substance) Items used during procedure --></usedReference>
 <usedCode><!-- 0..* CodeableConcept Coded items used during the procedure --></usedCode>
</Procedure>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "Procedure",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "|
   
  "
  "
  "
  "
  "
  "
  "
  "
  "
  
  ">",
  " },
  "
    "
    "|
    
    "

  "identifier" : [{ Identifier }], // External Identifiers for this procedure
  "instantiates" : ["<uri>"], // Instantiates 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 | suspended | aborted | 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
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or episode associated with the procedure
  // 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
    "role" : { CodeableConcept }, // The role the actor was in
    "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

}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Procedure;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:

  fhir:Procedure.identifier [ Identifier ], ... ; # 0..* External Identifiers for this procedure
  fhir:Procedure.instantiates [ uri ], ... ; # 0..* Instantiates protocol or definition
  fhir:Procedure.basedOn [ Reference(CarePlan|ServiceRequest) ], ... ; # 0..* A request for this procedure

  fhir:Procedure.partOf [ Reference(Procedure|Observation|MedicationAdministration) ], ... ; # 0..* Part of referenced event
  fhir:
  fhir:
  fhir:

  fhir:Procedure.status [ code ]; # 1..1 preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown
  fhir:Procedure.statusReason [ CodeableConcept ]; # 0..1 Reason for current status

  fhir:Procedure.category [ CodeableConcept ]; # 0..1 Classification of the procedure
  fhir:Procedure.code [ CodeableConcept ]; # 0..1 Identification of the procedure
  fhir:Procedure.subject [ Reference(Patient|Group) ]; # 1..1 Who the procedure was performed on
  fhir:Procedure.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or episode associated with the procedure
  # . One of these 2
    fhir: ]
    fhir: ]

  # Procedure.performed[x] : 0..1 When the procedure was performed. One of these 5
    fhir:Procedure.performedDateTime [ dateTime ]
    fhir:Procedure.performedPeriod [ Period ]
    fhir:Procedure.performedString [ string ]
    fhir:Procedure.performedAge [ Age ]
    fhir:Procedure.performedRange [ Range ]
  fhir:Procedure.recorder [ Reference(Patient|RelatedPerson|Practitioner|PractitionerRole) ]; # 0..1 Who recorded the procedure
  fhir:Procedure.asserter [ Reference(Patient|RelatedPerson|Practitioner|PractitionerRole) ]; # 0..1 Person who asserts this procedure

  fhir:Procedure.performer [ # 0..* The people who performed the procedure
    fhir:Procedure.performer.role [ CodeableConcept ]; # 0..1 The role the actor was in
    fhir:

    fhir:Procedure.performer.actor [ Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device) ]; # 1..1 The reference to the practitioner

    fhir:Procedure.performer.onBehalfOf [ Reference(Organization) ]; # 0..1 Organization the device or practitioner was acting for
  ], ...;
  fhir:Procedure.location [ Reference(Location) ]; # 0..1 Where the procedure happened
  fhir:Procedure.reasonCode [ CodeableConcept ], ... ; # 0..* Coded reason procedure performed
  fhir:

  fhir:Procedure.reasonReference [ Reference(Condition|Observation|Procedure|DiagnosticReport|DocumentReference) ], ... ; # 0..* The justification that the procedure was performed

  fhir:Procedure.bodySite [ CodeableConcept ], ... ; # 0..* Target body sites
  fhir:Procedure.outcome [ CodeableConcept ]; # 0..1 The result of procedure
  fhir:

  fhir:Procedure.report [ Reference(DiagnosticReport|DocumentReference|Composition) ], ... ; # 0..* Any report resulting from the procedure

  fhir:Procedure.complication [ CodeableConcept ], ... ; # 0..* Complication following the procedure
  fhir:

  fhir:Procedure.complicationDetail [ Reference(Condition) ], ... ; # 0..* A condition that is a result of the procedure

  fhir:Procedure.followUp [ CodeableConcept ], ... ; # 0..* Instructions for follow up
  fhir:
  fhir:

  fhir:Procedure.note [ Annotation ], ... ; # 0..* Additional information about the procedure
  fhir:Procedure.focalDevice [ # 0..* Manipulated, implanted, or removed device

    fhir:Procedure.focalDevice.action [ CodeableConcept ]; # 0..1 Kind of change to device
    fhir:Procedure.focalDevice.manipulated [ Reference(Device) ]; # 1..1 Device that was changed
  ], ...;
  fhir:Procedure.usedReference [ Reference(Device|Medication|Substance) ], ... ; # 0..* Items used during procedure
  fhir:Procedure.usedCode [ CodeableConcept ], ... ; # 0..* Coded items used during the procedure
]

Changes since DSTU2 R3

Procedure
Procedure.definition Procedure.instantiates
  • Added Element
Procedure.basedOn
  • Renamed from request to basedOn Max Cardinality Type changed from 1 Reference(CarePlan|ProcedureRequest|ReferralRequest) to * Remove Reference(DiagnosticOrder) Reference(CarePlan|ServiceRequest)
Procedure.partOf Procedure.statusReason
  • Added Element
Procedure.status Change value set from http://hl7.org/fhir/ValueSet/procedure-status to http://hl7.org/fhir/ValueSet/event-status Procedure.notDone Renamed from notPerformed to notDone Procedure.notDoneReason Renamed from reasonNotPerformed to notDoneReason Max Cardinality changed from * to 1 Procedure.code Min Cardinality changed from 1 to 0 Procedure.context Procedure.performed[x]
  • Renamed from encounter to context Add Reference(EpisodeOfCare) Procedure.performer.actor Min Cardinality changed from 0 to 1 string, Add Reference(Device) Procedure.performer.onBehalfOf Added Element Age, Add Range
Procedure.reasonCode Procedure.recorder
  • Added Element
Procedure.reasonReference Procedure.asserter
  • Added Element
Procedure.complicationDetail Procedure.performer.actor
  • Added Element Type changed from Reference(Practitioner|Organization|Patient|RelatedPerson|Device) to Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device)
Procedure.note Procedure.reasonReference
  • Renamed Type changed from notes Reference(Condition|Observation) to note Reference(Condition|Observation|Procedure|DiagnosticReport|DocumentReference)
Procedure.focalDevice.action Procedure.report
  • Remove Binding http://hl7.org/fhir/ValueSet/device-action (required) Type changed from Reference(DiagnosticReport) to Reference(DiagnosticReport|DocumentReference|Composition)
Procedure.usedReference Procedure.definition
  • Renamed from used to usedReference deleted
Procedure.usedCode Procedure.notDone
  • Added Element deleted
Procedure.reason[x] Procedure.notDoneReason
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 Conversion Maps (status = 9 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4

Structure

Name Flags Card. Type Description & Constraints doco
. . Procedure I TU DomainResource An action that is being or was performed on a patient
+ Reason not done is only permitted if notDone indicator is true Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier External Identifiers for this procedure
. . definition . instantiates Σ 0..* Reference ( PlanDefinition | ActivityDefinition | HealthcareService uri ) Instantiates protocol or definition
. . . basedOn Σ 0..* Reference ( CarePlan | ProcedureRequest | ReferralRequest ServiceRequest ) A request for this procedure
. . . partOf Σ 0..* Reference ( Procedure | Observation | MedicationAdministration ) Part of referenced event
. . . status ?! Σ 1..1 code preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown
EventStatus ( Required )
. . notDone ?! Σ 0..1 boolean True if procedure was not performed as scheduled . notDoneReason statusReason Σ I 0..1 CodeableConcept Reason procedure was not performed for current status
Procedure Not Performed Reason (SNOMED-CT) ( Example )
. . . category Σ 0..1 CodeableConcept Classification of the procedure
Procedure Category Codes (SNOMED CT) ( Example )
. . . code Σ 0..1 CodeableConcept Identification of the procedure
Procedure Codes (SNOMED CT) ( Example )
. . . subject Σ 1..1 Reference ( Patient | Group ) Who the procedure was performed on
. . . context Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or episode associated with the procedure
. . . performed[x] Σ 0..1 Date/Period When the procedure was performed
. . . . performedDateTime dateTime
. . . . performedPeriod Period
. . . . performedString string
.... performedAge Age
.... performedRange Range
... recorder Σ 0..1 Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole ) Who recorded the procedure
... asserter Σ 0..1 Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole ) Person who asserts this procedure
. . . performer Σ 0..* BackboneElement The people who performed the procedure
. . . . role Σ 0..1 CodeableConcept The role the actor was in
Procedure Performer Role Codes ( Example )
. . . . actor Σ 1..1 Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device ) The reference to the practitioner
. . . . onBehalfOf 0..1 Reference ( Organization ) Organization the device or practitioner was acting for
. . . location Σ 0..1 Reference ( Location ) Where the procedure happened
. . . reasonCode Σ 0..* CodeableConcept Coded reason procedure performed
Procedure Reason Codes ( Example )
. . . reasonReference Σ 0..* Reference ( Condition | Observation | Procedure | DiagnosticReport | DocumentReference ) Condition The justification that is the reason the procedure was performed
. . . bodySite Σ 0..* CodeableConcept Target body sites
SNOMED CT Body Structures ( Example )
. . . outcome Σ 0..1 CodeableConcept The result of procedure
Procedure Outcome Codes (SNOMED CT) ( Example )
. . . report 0..* Reference ( DiagnosticReport | DocumentReference | Composition ) Any report resulting from the procedure
. . . complication 0..* CodeableConcept Complication following the procedure
Condition/Problem/Diagnosis Codes ( Example )
. . . complicationDetail 0..* Reference ( Condition ) A condition that is that is a result of the procedure
. . . followUp 0..* CodeableConcept Instructions for follow up
Procedure Follow up Codes (SNOMED CT) ( Example )
. . . note 0..* Annotation Additional information about the procedure
. . . focalDevice 0..* BackboneElement Device changed in procedure Manipulated, implanted, or removed device
. . . . action 0..1 CodeableConcept Kind of change to device
Procedure Device Action Codes ( Preferred )
. . . . manipulated 1..1 Reference ( Device ) Device that was changed
. . . usedReference 0..* Reference ( Device | Medication | Substance ) Items used during procedure
. . . usedCode 0..* CodeableConcept Coded items used during the procedure
FHIR Device Types ( Example )

doco Documentation for this format

UML Diagram ( Legend )

Procedure ( DomainResource ) This records Business identifiers associated with assigned to this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the performer or other systems which remain constant as the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation) updated and propagates from server to server identifier : Identifier [0..*] A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure definition instantiates : Reference uri [0..*] PlanDefinition | ActivityDefinition | HealthcareService A reference to a resource that contains details of the request for this procedure basedOn : Reference [0..*] « CarePlan | ProcedureRequest | ReferralRequest ServiceRequest » A larger event of which this particular procedure is a component or step partOf : Reference [0..*] « Procedure | Observation | MedicationAdministration » A code specifying the state of the procedure. Generally this will be in-progress or completed state (this element modifies the meaning of other elements) status : code [1..1] « A code specifying the state of the procedure. (Strength=Required) EventStatus ! » Set this to true if the record is saying that Captures the procedure was NOT performed (this element modifies reason for the meaning current state of other elements) notDone : boolean [0..1] A code indicating why the procedure was not performed notDoneReason statusReason : CodeableConcept [0..1] « A code that identifies the reason a procedure was not performed. (Strength=Example) Procedure Not Performed Reaso... ?? » A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure") "Surgical Procedure") category : CodeableConcept [0..1] « A code that classifies a procedure for searching, sorting and display purposes. (Strength=Example) Procedure Category Codes (SNO... ?? » The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy") "Laparoscopic Appendectomy") code : CodeableConcept [0..1] « A code to identify a specific procedure . (Strength=Example) Procedure Codes (SNOMED CT) ?? » The person, animal or group on which the procedure was performed subject : Reference [1..1] « Patient | Group » The encounter during which the procedure was performed context : Reference [0..1] « Encounter | EpisodeOfCare » The date(time)/period over which 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 performed[x] : Type [0..1] « dateTime | Period | string | Age | Range » Individual who recorded the record and takes responsibility for its content recorder : Reference [0..1] « Patient | RelatedPerson | Practitioner | PractitionerRole » Individual who is making the procedure statement asserter : Reference [0..1] « Patient | RelatedPerson | Practitioner | PractitionerRole » The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant location : Reference [0..1] « Location » The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text reasonCode : CodeableConcept [0..*] « A code that identifies the reason a procedure is required. (Strength=Example) Procedure Reason ?? » The condition that is the reason justification of why the procedure was performed reasonReference : Reference [0..*] « Condition | Observation | Procedure | DiagnosticReport | DocumentReference » Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion bodySite : CodeableConcept [0..*] « Codes describing anatomical locations. May include laterality. (Strength=Example) SNOMED CT Body Structures ?? » The outcome of the procedure - did it resolve reasons for the procedure being performed? outcome : CodeableConcept [0..1] « An outcome of a procedure - whether it was resolved or otherwise. (Strength=Example) Procedure Outcome Codes (SNOM... ?? » This could be a histology result, pathology report, surgical report, etc. etc report : Reference [0..*] « DiagnosticReport | DocumentReference | Composition » 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 complication : CodeableConcept [0..*] « Codes describing complications that resulted from a procedure. (Strength=Example) Condition/Problem/Diagnosis ?? » Any complications that occurred during the procedure, or in the immediate post-performance period complicationDetail : Reference [0..*] « Condition » 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 followUp : CodeableConcept [0..*] « Specific follow up required for a procedure e.g. removal of sutures. (Strength=Example) Procedure Follow up Codes (SN... ?? » Any other notes and comments about the procedure. E.g. the operative notes procedure note : Annotation [0..*] Identifies medications, devices and any other substance used as part of the procedure usedReference : Reference [0..*] « Device | Medication | Substance » Identifies coded items that were used as part of the procedure usedCode : CodeableConcept [0..*] « Codes describing items used during a procedure (Strength=Example) FHIR Device Types ?? » Performer For example: surgeon, anaethetist, endoscopist role : CodeableConcept [0..1] « A code that identifies the role of a performer of the procedure. (Strength=Example) Procedure Performer Role ?? » The practitioner who was involved in the procedure actor : Reference [1..1] « Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device » The organization the device or practitioner was acting on behalf of onBehalfOf : Reference [0..1] « Organization » FocalDevice The kind of change that happened to the device during the procedure action : CodeableConcept [0..1] « A kind of change that happened to the device during the procedure. (Strength=Preferred) Procedure Device Action ? » The device that was manipulated (changed) during the procedure manipulated : Reference [1..1] « Device » Limited to 'real' people rather than equipment performer [0..*] 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 focalDevice [0..*]

XML Template 

<

<Procedure xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <|
   </definition>
 <</basedOn>

 <identifier><!-- 0..* Identifier External Identifiers for this procedure --></identifier>
 <instantiates value="[uri]"/><!-- 0..* Instantiates protocol or definition -->
 <basedOn><!-- 0..* Reference(CarePlan|ServiceRequest) A request for this procedure --></basedOn>

 <partOf><!-- 0..* Reference(Procedure|Observation|MedicationAdministration) Part of referenced event --></partOf>
 <
 <
 <</notDoneReason>

 <status value="[code]"/><!-- 1..1 preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown -->
 <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason>

 <category><!-- 0..1 CodeableConcept Classification of the procedure --></category>
 <code><!-- 0..1 CodeableConcept Identification of the procedure --></code>
 <subject><!-- 1..1 Reference(Patient|Group) Who the procedure was performed on --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or episode associated with the procedure --></context>
 <</performed[x]>

 <performed[x]><!-- 0..1 dateTime|Period|string|Age|Range When the procedure was performed --></performed[x]>
 <recorder><!-- 0..1 Reference(Patient|RelatedPerson|Practitioner|
   PractitionerRole) Who recorded the procedure --></recorder>

 <asserter><!-- 0..1 Reference(Patient|RelatedPerson|Practitioner|
   PractitionerRole) Person who asserts this procedure --></asserter>
 <performer>  <!-- 0..* The people who performed the procedure -->
  <role><!-- 0..1 CodeableConcept The role the actor was in --></role>
  <|
    </actor>

  <actor><!-- 1..1 Reference(Practitioner|PractitionerRole|Organization|Patient|
    RelatedPerson|Device) The reference to the practitioner --></actor>
  <onBehalfOf><!-- 0..1 Reference(Organization) Organization the device or practitioner was acting for --></onBehalfOf>
 </performer>
 <location><!-- 0..1 Reference(Location) Where the procedure happened --></location>
 <reasonCode><!-- 0..* CodeableConcept Coded reason procedure performed --></reasonCode>
 <</reasonReference>

 <reasonReference><!-- 0..* Reference(Condition|Observation|Procedure|
   DiagnosticReport|DocumentReference) The justification that the procedure was performed --></reasonReference>
 <bodySite><!-- 0..* CodeableConcept Target body sites --></bodySite>
 <outcome><!-- 0..1 CodeableConcept The result of procedure --></outcome>
 <</report>

 <report><!-- 0..* Reference(DiagnosticReport|DocumentReference|Composition) Any report resulting from the procedure --></report>

 <complication><!-- 0..* CodeableConcept Complication following the procedure --></complication>
 <</complicationDetail>

 <complicationDetail><!-- 0..* Reference(Condition) A condition that is a result of the procedure --></complicationDetail>

 <followUp><!-- 0..* CodeableConcept Instructions for follow up --></followUp>
 <</note>
 <

 <note><!-- 0..* Annotation Additional information about the procedure --></note>
 <focalDevice>  <!-- 0..* Manipulated, implanted, or removed device -->

  <action><!-- 0..1 CodeableConcept Kind of change to device --></action>
  <manipulated><!-- 1..1 Reference(Device) Device that was changed --></manipulated>
 </focalDevice>
 <usedReference><!-- 0..* Reference(Device|Medication|Substance) Items used during procedure --></usedReference>
 <usedCode><!-- 0..* CodeableConcept Coded items used during the procedure --></usedCode>
</Procedure>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "Procedure",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "|
   
  "
  "
  "
  "
  "
  "
  "
  "
  "
  
  ">",
  " },
  "
    "
    "|
    
    "

  "identifier" : [{ Identifier }], // External Identifiers for this procedure
  "instantiates" : ["<uri>"], // Instantiates 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 | suspended | aborted | 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
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or episode associated with the procedure
  // 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
    "role" : { CodeableConcept }, // The role the actor was in
    "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

}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Procedure;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:

  fhir:Procedure.identifier [ Identifier ], ... ; # 0..* External Identifiers for this procedure
  fhir:Procedure.instantiates [ uri ], ... ; # 0..* Instantiates protocol or definition
  fhir:Procedure.basedOn [ Reference(CarePlan|ServiceRequest) ], ... ; # 0..* A request for this procedure

  fhir:Procedure.partOf [ Reference(Procedure|Observation|MedicationAdministration) ], ... ; # 0..* Part of referenced event
  fhir:
  fhir:
  fhir:

  fhir:Procedure.status [ code ]; # 1..1 preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown
  fhir:Procedure.statusReason [ CodeableConcept ]; # 0..1 Reason for current status

  fhir:Procedure.category [ CodeableConcept ]; # 0..1 Classification of the procedure
  fhir:Procedure.code [ CodeableConcept ]; # 0..1 Identification of the procedure
  fhir:Procedure.subject [ Reference(Patient|Group) ]; # 1..1 Who the procedure was performed on
  fhir:Procedure.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or episode associated with the procedure
  # . One of these 2
    fhir: ]
    fhir: ]

  # Procedure.performed[x] : 0..1 When the procedure was performed. One of these 5
    fhir:Procedure.performedDateTime [ dateTime ]
    fhir:Procedure.performedPeriod [ Period ]
    fhir:Procedure.performedString [ string ]
    fhir:Procedure.performedAge [ Age ]
    fhir:Procedure.performedRange [ Range ]
  fhir:Procedure.recorder [ Reference(Patient|RelatedPerson|Practitioner|PractitionerRole) ]; # 0..1 Who recorded the procedure
  fhir:Procedure.asserter [ Reference(Patient|RelatedPerson|Practitioner|PractitionerRole) ]; # 0..1 Person who asserts this procedure

  fhir:Procedure.performer [ # 0..* The people who performed the procedure
    fhir:Procedure.performer.role [ CodeableConcept ]; # 0..1 The role the actor was in
    fhir:

    fhir:Procedure.performer.actor [ Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device) ]; # 1..1 The reference to the practitioner

    fhir:Procedure.performer.onBehalfOf [ Reference(Organization) ]; # 0..1 Organization the device or practitioner was acting for
  ], ...;
  fhir:Procedure.location [ Reference(Location) ]; # 0..1 Where the procedure happened
  fhir:Procedure.reasonCode [ CodeableConcept ], ... ; # 0..* Coded reason procedure performed
  fhir:

  fhir:Procedure.reasonReference [ Reference(Condition|Observation|Procedure|DiagnosticReport|DocumentReference) ], ... ; # 0..* The justification that the procedure was performed

  fhir:Procedure.bodySite [ CodeableConcept ], ... ; # 0..* Target body sites
  fhir:Procedure.outcome [ CodeableConcept ]; # 0..1 The result of procedure
  fhir:

  fhir:Procedure.report [ Reference(DiagnosticReport|DocumentReference|Composition) ], ... ; # 0..* Any report resulting from the procedure

  fhir:Procedure.complication [ CodeableConcept ], ... ; # 0..* Complication following the procedure
  fhir:

  fhir:Procedure.complicationDetail [ Reference(Condition) ], ... ; # 0..* A condition that is a result of the procedure

  fhir:Procedure.followUp [ CodeableConcept ], ... ; # 0..* Instructions for follow up
  fhir:
  fhir:

  fhir:Procedure.note [ Annotation ], ... ; # 0..* Additional information about the procedure
  fhir:Procedure.focalDevice [ # 0..* Manipulated, implanted, or removed device

    fhir:Procedure.focalDevice.action [ CodeableConcept ]; # 0..1 Kind of change to device
    fhir:Procedure.focalDevice.manipulated [ Reference(Device) ]; # 1..1 Device that was changed
  ], ...;
  fhir:Procedure.usedReference [ Reference(Device|Medication|Substance) ], ... ; # 0..* Items used during procedure
  fhir:Procedure.usedCode [ CodeableConcept ], ... ; # 0..* Coded items used during the procedure
]

Changes since DSTU2

Procedure
Procedure.definition Procedure.instantiates
  • Added Element
Procedure.basedOn
  • Renamed from request to basedOn Max Cardinality Type changed from 1 Reference(CarePlan|ProcedureRequest|ReferralRequest) to * Remove Reference(DiagnosticOrder) Reference(CarePlan|ServiceRequest)
Procedure.partOf Procedure.statusReason
  • Added Element
Procedure.status Change value set from http://hl7.org/fhir/ValueSet/procedure-status to http://hl7.org/fhir/ValueSet/event-status Procedure.notDone Renamed from notPerformed to notDone Procedure.notDoneReason Renamed from reasonNotPerformed to notDoneReason Max Cardinality changed from * to 1 Procedure.code Min Cardinality changed from 1 to 0 Procedure.context Procedure.performed[x]
  • Renamed from encounter to context Add Reference(EpisodeOfCare) Procedure.performer.actor Min Cardinality changed from 0 to 1 string, Add Reference(Device) Procedure.performer.onBehalfOf Added Element Age, Add Range
Procedure.reasonCode Procedure.recorder
  • Added Element
Procedure.reasonReference Procedure.asserter
  • Added Element
Procedure.complicationDetail Procedure.performer.actor
  • Added Element Type changed from Reference(Practitioner|Organization|Patient|RelatedPerson|Device) to Reference(Practitioner|PractitionerRole|Organization|Patient|RelatedPerson|Device)
Procedure.note Procedure.reasonReference
  • Renamed Type changed from notes Reference(Condition|Observation) to note Reference(Condition|Observation|Procedure|DiagnosticReport|DocumentReference)
Procedure.focalDevice.action Procedure.report
  • Remove Binding http://hl7.org/fhir/ValueSet/device-action (required) Type changed from Reference(DiagnosticReport) to Reference(DiagnosticReport|DocumentReference|Composition)
Procedure.usedReference Procedure.definition
  • Renamed from used to usedReference deleted
Procedure.usedCode Procedure.notDone
  • Added Element deleted
Procedure.reason[x] Procedure.notDoneReason
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 Conversion Maps (status = 9 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). Note: these have note yet been updated to be R3 to R4

 

Alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

9.3.3.1 Terminology Bindings

Path Definition Type Reference
Procedure.status A code specifying the state of the procedure. Required EventStatus
Procedure.notDoneReason Procedure.statusReason A code that identifies the reason a procedure was not performed. Example Procedure Not Performed Reason (SNOMED-CT)
Procedure.category A code that classifies a procedure for searching, sorting and display purposes. Example Procedure Category Codes (SNOMED CT)
Procedure.code A code to identify a specific procedure . Example Procedure Codes (SNOMED CT)
Procedure.performer.role A code that identifies the role of a performer of the procedure. Example Procedure Performer Role Codes
Procedure.reasonCode A code that identifies the reason a procedure is required. Example Procedure Reason Codes
Procedure.bodySite Codes describing anatomical locations. May include laterality. Example SNOMED CT Body Structures
Procedure.outcome An outcome of a procedure - whether it was resolved or otherwise. Example Procedure Outcome Codes (SNOMED CT)
Procedure.complication Codes describing complications that resulted from a procedure. Example Condition/Problem/Diagnosis Codes
Procedure.followUp Specific follow up required for a procedure e.g. removal of sutures. Example Procedure Follow up Codes (SNOMED CT)
Procedure.focalDevice.action A kind of change that happened to the device during the procedure. Preferred Procedure Device Action Codes
Procedure.usedCode Codes describing items used during a procedure Example FHIR Device Types

9.3.3.2 Constraints pro-1 : Reason not done is only permitted if notDone indicator is true ( expression : notDoneReason.empty() or notDone = true ) 9.3.3.3 Use of Procedure properties

Many of the elements of Procedure have inherent relationships and may be conveyed by the Procedure.code or in the text element of the Procedure.code property. I.e. You may be able to infer category, bodySite and even indication. Whether these other properties will be populated may vary by implementation.

Care should be taken to avoid nonsensical combinations/statements; e.g. "name=amputation, bodySite=heart" "name=amputation, bodySite=heart"

9.3.3.4 9.3.3.3 Use of Procedure.used

For devices, these are devices that are incidental to / or used to perform the procedure - scalpels, gauze, endoscopes, etc. Devices that are the focus of the procedure should appear in Procedure.device instead.

9.3.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
based-on reference A request for this procedure Procedure.basedOn
( ReferralRequest , CarePlan , ProcedureRequest ServiceRequest )
category token Classification of the procedure Procedure.category
code token A code to identify a procedure Procedure.code 8 Resources
context reference Encounter or episode associated with the procedure Procedure.context
( EpisodeOfCare , Encounter )
date date Date/Period When the procedure was performed Procedure.performed 18 17 Resources
definition reference Instantiates protocol or definition Procedure.definition ( PlanDefinition , HealthcareService , ActivityDefinition ) encounter reference Search by encounter Procedure.context
( Encounter ) 		12 Resources
identifier token A unique identifier for a procedure Procedure.identifier 26 Resources
instantiates uri Instantiates protocol or definition Procedure.instantiates
location reference Where the procedure happened Procedure.location
( Location )
part-of reference Part of referenced event Procedure.partOf
( Observation , Procedure , MedicationAdministration )
patient reference Search by subject - a patient Procedure.subject
( Patient ) 		31 29 Resources
performer reference The reference to the practitioner Procedure.performer.actor
( Practitioner , Organization , Device , Patient , PractitionerRole , RelatedPerson )
status token preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown Procedure.status
subject reference Search by subject Procedure.subject
( Group , Patient )