This page is part of the International Patient Summary Implementation Guide (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-procedure-uv-ips Profile.
Procedure | |
Definition | 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. |
Control | 0..* |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.div.exists()) |
Procedure.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Procedure.meta | |
Definition | 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. |
Control | 0..1 |
Type | Meta |
Procedure.implicitRules | |
Definition | 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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Procedure.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHOULD be taken from Common Languages |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Procedure.text | |
Definition | 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. |
Control | 0..1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Procedure.contained | |
Definition | 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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Procedure.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Procedure.extension ([CanonicalType[http://hl7.org/fhir/uv/ips/StructureDefinition/statement-uv-ips]]) | |
Definition | An Extension |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Procedure.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Procedure.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Procedure.extension.extension(statementNote) | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Procedure.extension.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Procedure.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Procedure.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Procedure.extension.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Procedure.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Procedure.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Procedure.modifierExtension | |
Definition | 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. 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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Procedure.identifier | |
Definition | Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows identification of the procedure as it is known by various participating systems and in a way that remains consistent across servers. |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Procedure.instantiatesCanonical | |
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Procedure. |
Control | 0..* |
Type | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) |
Procedure.instantiatesUri | |
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Procedure. |
Control | 0..* |
Type | uri |
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. |
Procedure.basedOn | |
Definition | A reference to a resource that contains details of the request for this procedure. |
Control | 0..* |
Type | Reference(CarePlan | ServiceRequest) |
Alternate Names | fulfills |
Procedure.partOf | |
Definition | A larger event of which this particular procedure is a component or step. |
Control | 0..* |
Type | Reference(Procedure) |
Alternate Names | container |
Comments | The MedicationAdministration has a partOf reference to Procedure, but this is not a circular reference. For example, the anesthesia MedicationAdministration is part of the surgical Procedure (MedicationAdministration.partOf = Procedure). For example, the procedure to insert the IV port for an IV medication administration is part of the medication administration (Procedure.partOf = MedicationAdministration). |
Procedure.status | |
Definition | A code specifying the state of the procedure. Generally this will be in-progress or completed state. |
Control | 1..1 |
Binding | A code specifying the state of the procedure. The codes SHALL be taken from EventStatus |
Type | code |
Is Modifier | true |
Must Support | true |
Comments | The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Procedure.statusReason | |
Definition | Captures the reason for the current state of the procedure. |
Control | 0..1 |
Binding | A code that identifies the reason a procedure was not performed. For example codes, see ProcedureNotPerformedReason(SNOMED-CT) |
Type | CodeableConcept |
Alternate Names | Suspended Reason, Cancelled Reason |
Comments | This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here. |
Procedure.category | |
Definition | A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). |
Control | 0..1 |
Binding | A code that classifies a procedure for searching, sorting and display purposes. For example codes, see ProcedureCategoryCodes(SNOMEDCT) |
Type | CodeableConcept |
Procedure.code | |
Definition | The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy"). |
Control | 0..1 |
Binding | The codes SHOULD be taken from IPSProcedures |
Type | CodeableConcept |
Must Support | true |
Requirements | 0..1 to account for primarily narrative only resources. |
Alternate Names | type |
Procedure.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Procedure.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Procedure.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..* |
Type | Coding |
Must Support | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Procedure.code.coding(absentOrUnknownProcedure) | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | A code to identify absent or unknown procedures The codes SHALL be taken from IPSNoProceduresInfos |
Type | Coding(coding-uv-ips) |
Must Support | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Procedure.code.coding(procedureCode) | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | The codes SHOULD be taken from IPSProcedures |
Type | Coding(coding-uv-ips) |
Must Support | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Procedure.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Procedure.subject | |
Definition | The person on which the procedure was performed. |
Control | 1..1 |
Type | Reference(Patient) |
Must Support | true |
Alternate Names | patient |
Procedure.subject.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Procedure.subject.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Procedure.subject.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Procedure.subject.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Control | 0..1 |
Binding | Aa resource (or, for logical models, the URI of the logical model). The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable |
Type | uri |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Procedure.subject.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..0 |
Type | Identifier |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Procedure.subject.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Procedure.context | |
Definition | The encounter during which the procedure was performed. |
Control | 0..1 |
Type | Reference(Encounter | EpisodeOfCare) |
Alternate Names | encounter |
Procedure.performed[x] | |
Definition | 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. |
Control | 1..1 |
Type | Choice of: dateTime, Period, string, Age, Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Comments | Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old. dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone. |
Procedure.recorder | |
Definition | Individual who recorded the record and takes responsibility for its content. |
Control | 0..1 |
Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
Procedure.asserter | |
Definition | Individual who is making the procedure statement. |
Control | 0..1 |
Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
Procedure.performer | |
Definition | Limited to 'real' people rather than equipment. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Procedure.performer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Procedure.performer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Procedure.performer.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. 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 can 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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Procedure.performer.function | |
Definition | Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaethetist, endoscopist. |
Control | 0..1 |
Binding | A code that identifies the role of a performer of the procedure. For example codes, see ProcedurePerformerRoleCodes |
Type | CodeableConcept |
Requirements | Allows disambiguation of the types of involvement of different performers. |
Procedure.performer.actor | |
Definition | The practitioner who was involved in the procedure. |
Control | 1..1 |
Type | Reference(Patient | RelatedPerson | Device-observer-uv-ips | Practitioner-uv-ips | Organization-observation-uv-ips) |
Requirements | A reference to Device supports use cases, such as pacemakers. |
Procedure.performer.onBehalfOf | |
Definition | The organization the device or practitioner was acting on behalf of. |
Control | 0..1 |
Type | Reference(Organization-observation-uv-ips) |
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when performing the action. |
Procedure.location | |
Definition | The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. |
Control | 0..1 |
Type | Reference(Location) |
Requirements | Ties a procedure to where the records are likely kept. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. TRILLIUM II IMPLEMENTATION COMMENTS: We propose to encode it with SNOMED CT. |
Procedure.reasonCode | |
Definition | The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text. |
Control | 0..* |
Binding | For example codes, see ProcedureReasonCodes |
Type | CodeableConcept |
Comments | Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure. |
Procedure.reasonReference | |
Definition | The justification of why the procedure was performed. |
Control | 0..* |
Type | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) |
Comments | It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as epidural). Other examples include endoscopy for dilatation and biopsy, combination diagnosis and therapeutic. Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure. |
Procedure.bodySite | |
Definition | Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. |
Control | 0..* |
Binding | For example codes, see IPSTargetSiteCode |
Type | CodeableConcept |
Must Support | true |
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension procedure-targetbodystructure. |
Procedure.outcome | |
Definition | The outcome of the procedure - did it resolve reasons for the procedure being performed? |
Control | 0..1 |
Binding | An outcome of a procedure - whether it was resolved or otherwise. For example codes, see ProcedureOutcomeCodes(SNOMEDCT) |
Type | CodeableConcept |
Comments | If outcome contains narrative text only, it can be captured using the CodeableConcept.text. |
Procedure.report | |
Definition | This could be a histology result, pathology report, surgical report, etc. |
Control | 0..* |
Type | Reference(DiagnosticReport | DocumentReference | Composition) |
Comments | There could potentially be multiple reports - e.g. if this was a procedure which took multiple biopsies resulting in a number of anatomical pathology reports. |
Procedure.complication | |
Definition | 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. |
Control | 0..* |
Binding | Codes describing complications that resulted from a procedure. For example codes, see Condition/Problem/DiagnosisCodes |
Type | CodeableConcept |
Comments | If complications are only expressed by the narrative text, they can be captured using the CodeableConcept.text. |
Procedure.complicationDetail | |
Definition | Any complications that occurred during the procedure, or in the immediate post-performance period. |
Control | 0..* |
Type | Reference(Condition) |
Requirements | This is used to document a condition that is a result of the procedure, not the condition that was the reason for the procedure. |
Procedure.followUp | |
Definition | 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. |
Control | 0..* |
Binding | Specific follow up required for a procedure e.g. removal of sutures. For example codes, see ProcedureFollowUpCodes(SNOMEDCT) |
Type | CodeableConcept |
Procedure.note | |
Definition | Any other notes and comments about the procedure. |
Control | 0..* |
Type | Annotation |
Procedure.focalDevice | |
Definition | 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. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Procedure.focalDevice.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Procedure.focalDevice.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Procedure.focalDevice.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. 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 can 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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Procedure.focalDevice.action | |
Definition | The kind of change that happened to the device during the procedure. |
Control | 0..1 |
Binding | A kind of change that happened to the device during the procedure. The codes SHOULD be taken from ProcedureDeviceActionCodes |
Type | CodeableConcept |
Procedure.focalDevice.manipulated | |
Definition | The device that was manipulated (changed) during the procedure. |
Control | 1..1 |
Type | Reference(Device) |
Procedure.usedReference | |
Definition | Identifies medications, devices and any other substance used as part of the procedure. |
Control | 0..* |
Type | Reference(Device | Medication | Substance) |
Requirements | Used for tracking contamination, etc. |
Comments | For devices actually implanted or removed, use Procedure.device. |
Procedure.usedCode | |
Definition | Identifies coded items that were used as part of the procedure. |
Control | 0..* |
Binding | Codes describing items used during a procedure. For example codes, see FHIRDeviceTypes |
Type | CodeableConcept |
Comments | For devices actually implanted or removed, use Procedure.device. |