1.1.0 - release
This page is part of the KL Gateway (v1.1.0: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2023-06-21 |
Definitions for the klgateway-care-completed-intervention resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Procedure | |
2. Procedure.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..0* |
3. Procedure.instantiatesCanonical | |
Control | 0..0* |
4. Procedure.instantiatesUri | |
Control | 0..0* |
5. Procedure.basedOn | |
Control | 0..0* |
6. Procedure.partOf | |
Control | 0..0* |
7. Procedure.status | |
8. Procedure.statusReason | |
Control | 0..01 |
9. Procedure.category | |
Control | 0..01 |
10. Procedure.code | |
Control | 10..1 |
11. Procedure.code.coding | |
Control | 1..? |
Slicing | This element introduces a set of slices on Procedure.code.coding. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
12. Procedure.code.coding:level2 | |
SliceName | level2 |
Control | 1..1 |
Binding | The codes SHALL be taken from FSIIICareInterventions |
13. Procedure.code.coding:level2.system | |
Control | 1..? |
Pattern Value | urn:oid:1.2.208.176.2.21 |
14. Procedure.code.coding:level3 | |
SliceName | level3 |
Definition | Shall contain locally defined code if it is a locally defined level 3 intervention |
Control | 0..1 |
Must Support | true |
15. Procedure.code.coding:level3.system | |
Control | 1..? |
Pattern Value | http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions |
16. Procedure.code.coding:level3.code | |
Control | 1..? |
17. Procedure.code.coding:level3.display | |
Control | 1..? |
18. Procedure.subject | |
Type | Reference(KLGatewayCareCitizen|Patient|Group) : {b} |
19. Procedure.encounter | |
Control | 0..01 |
20. Procedure.performed[x] | |
Control | 10..1 |
Type | Choice of: , string, Period, Range, Age |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
21. Procedure.recorder | |
Control | 0..01 |
22. Procedure.asserter | |
Control | 0..01 |
23. Procedure.performer | |
Control | 0..0* |
24. Procedure.location | |
Control | 0..01 |
25. Procedure.reasonCode | |
Control | 0..0* |
26. Procedure.reasonReference | |
Definition | Reason for this intervention. Must contain all conditions known to be addressed by this intervention The justification of why the procedure was performed. |
Type | Reference(KLGatewayCareCondition|Condition|Observation|Procedure|DiagnosticReport|DocumentReference) : {b} |
Must Support | true |
27. Procedure.bodySite | |
Control | 0..0* |
28. Procedure.outcome | |
Control | 0..01 |
29. Procedure.report | |
Control | 0..0* |
30. Procedure.complication | |
Control | 0..0* |
31. Procedure.complicationDetail | |
Control | 0..0* |
32. Procedure.followUp | |
Control | 0..0* |
33. Procedure.note | |
Control | 0..0* |
34. Procedure.focalDevice | |
Control | 0..0* |
35. Procedure.usedReference | |
Control | 0..0* |
36. Procedure.usedCode | |
Control | 0..0* |
Guidance on how to interpret the contents of this table can be found here.
1. 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..* | ||
Summary | false | ||
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()) | ||
2. 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 | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | 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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
3. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
Control | 0..* | ||
Type | Extension | ||
Is Modifier | true | ||
Summary | false | ||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
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. | ||
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()) | ||
4. Procedure.identifier | |||
Definition | Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. | ||
Note | This is a business identifier, not a resource identifier (see discussion) | ||
Control | 0..0* | ||
Type | Identifier | ||
Summary | true | ||
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 Person resource instances might share the same social insurance number. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
5. Procedure.instantiatesCanonical | |||
Definition | The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. | ||
Control | 0..0* | ||
Type | canonical(PlanDefinition|ActivityDefinition|Measure|OperationDefinition|Questionnaire) | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
6. Procedure.instantiatesUri | |||
Definition | The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. | ||
Control | 0..0* | ||
Type | uri | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
7. Procedure.basedOn | |||
Definition | A reference to a resource that contains details of the request for this procedure. | ||
Control | 0..0* | ||
Type | Reference(CarePlan|ServiceRequest) | ||
Summary | true | ||
Alternate Names | fulfills | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
8. Procedure.partOf | |||
Definition | A larger event of which this particular procedure is a component or step. | ||
Control | 0..0* | ||
Type | Reference(Procedure|Observation|MedicationAdministration) | ||
Summary | true | ||
Alternate Names | container | ||
Comments | The MedicationAdministration resource 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). | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
9. Procedure.status | |||
Definition | A code specifying the state of the procedure. Generally, this will be the in-progress or completed state. | ||
Control | 1..1 | ||
Binding | The codes SHALL be taken from EventStatus A code specifying the state of the procedure. | ||
Type | code | ||
Is Modifier | true | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | 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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
10. Procedure.statusReason | |||
Definition | Captures the reason for the current state of the procedure. | ||
Control | 0..01 | ||
Binding | For example codes, see ProcedureNotPerformedReason(SNOMED-CT) A code that identifies the reason a procedure was not performed. | ||
Type | CodeableConcept | ||
Summary | true | ||
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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
11. Procedure.category | |||
Definition | A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). | ||
Control | 0..01 | ||
Binding | For example codes, see ProcedureCategoryCodes(SNOMEDCT) A code that classifies a procedure for searching, sorting and display purposes. | ||
Type | CodeableConcept | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
12. 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 | 10..1 | ||
Binding | For example codes, see ProcedureCodes(SNOMEDCT) A code to identify a specific procedure . | ||
Type | CodeableConcept | ||
Summary | true | ||
Requirements | 0..1 to account for primarily narrative only resources. | ||
Alternate Names | type | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
13. Procedure.code.coding | |||
Definition | A reference to a code defined by a terminology system. | ||
Control | 10..* | ||
Type | Coding | ||
Summary | 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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
Slicing | This element introduces a set of slices on Procedure.code.coding. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||
14. Procedure.code.coding:level2 | |||
SliceName | level2 | ||
Definition | A reference to a code defined by a terminology system. | ||
Control | 10..1* | ||
Binding | The codes SHALL be taken from FSIIICareInterventionsFor codes, see (unbound) | ||
Type | Coding | ||
Summary | 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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
15. Procedure.code.coding:level2.system | |||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Control | 10..1 | ||
Type | uri | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||
Pattern Value | urn:oid:1.2.208.176.2.21 | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
16. Procedure.code.coding:level3 | |||
SliceName | level3 | ||
Definition | Shall contain locally defined code if it is a locally defined level 3 intervention A reference to a code defined by a terminology system. | ||
Control | 0..1* | ||
Type | Coding | ||
Must Support | true | ||
Summary | 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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
17. Procedure.code.coding:level3.system | |||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Control | 10..1 | ||
Type | uri | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||
Pattern Value | http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
18. Procedure.code.coding:level3.code | |||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Control | 10..1 | ||
Type | code | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Requirements | Need to refer to a particular code in the system. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
19. Procedure.code.coding:level3.display | |||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Control | 10..1 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Obligations |
| ||
Summary | true | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
20. Procedure.subject | |||
Definition | The person, animal or group on which the procedure was performed. | ||
Control | 1..1 | ||
Type | Reference(KLGatewayCareCitizen|Patient|Group) : {b} | ||
Summary | true | ||
Alternate Names | patient | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
21. Procedure.encounter | |||
Definition | The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. | ||
Control | 0..01 | ||
Type | Reference(Encounter) | ||
Summary | true | ||
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
22. 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 | 10..1 | ||
Type | Choice of: dateTime, string, Period, Range, Age | ||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | 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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
23. Procedure.recorder | |||
Definition | Individual who recorded the record and takes responsibility for its content. | ||
Control | 0..01 | ||
Type | Reference(Patient|RelatedPerson|Practitioner|PractitionerRole) | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
24. Procedure.asserter | |||
Definition | Individual who is making the procedure statement. | ||
Control | 0..01 | ||
Type | Reference(Patient|RelatedPerson|Practitioner|PractitionerRole) | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
25. Procedure.performer | |||
Definition | Limited to "real" people rather than equipment. | ||
Control | 0..0* | ||
Type | BackboneElement | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
26. Procedure.location | |||
Definition | The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. | ||
Control | 0..01 | ||
Type | Reference(Location) | ||
Summary | true | ||
Requirements | Ties a procedure to where the records are likely kept. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
27. Procedure.reasonCode | |||
Definition | The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text. | ||
Control | 0..0* | ||
Binding | For example codes, see ProcedureReasonCodes A code that identifies the reason a procedure is required. | ||
Type | CodeableConcept | ||
Summary | true | ||
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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
28. Procedure.reasonReference | |||
Definition | Reason for this intervention. Must contain all conditions known to be addressed by this intervention The justification of why the procedure was performed. | ||
Control | 0..* | ||
Type | Reference(KLGatewayCareCondition|Condition|Observation|Procedure|DiagnosticReport|DocumentReference) : {b} | ||
Must Support | true | ||
Summary | true | ||
Comments | It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as an epidural). Other examples include endoscopy for dilatation and biopsy (a combination of diagnostic and therapeutic use). 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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
29. Procedure.bodySite | |||
Definition | Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. | ||
Control | 0..0* | ||
Binding | For example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality. | ||
Type | CodeableConcept | ||
Summary | 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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
30. Procedure.outcome | |||
Definition | The outcome of the procedure - did it resolve the reasons for the procedure being performed? | ||
Control | 0..01 | ||
Binding | For example codes, see ProcedureOutcomeCodes(SNOMEDCT) An outcome of a procedure - whether it was resolved or otherwise. | ||
Type | CodeableConcept | ||
Summary | true | ||
Comments | If outcome contains narrative text only, it can be captured using the CodeableConcept.text. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
31. Procedure.report | |||
Definition | This could be a histology result, pathology report, surgical report, etc. | ||
Control | 0..0* | ||
Type | Reference(DiagnosticReport|DocumentReference|Composition) | ||
Summary | false | ||
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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
32. 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..0* | ||
Binding | For example codes, see Condition/Problem/DiagnosisCodes Codes describing complications that resulted from a procedure. | ||
Type | CodeableConcept | ||
Summary | false | ||
Comments | If complications are only expressed by the narrative text, they can be captured using the CodeableConcept.text. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
33. Procedure.complicationDetail | |||
Definition | Any complications that occurred during the procedure, or in the immediate post-performance period. | ||
Control | 0..0* | ||
Type | Reference(Condition) | ||
Summary | false | ||
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. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
34. Procedure.followUp | |||
Definition | If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used. | ||
Control | 0..0* | ||
Binding | For example codes, see ProcedureFollowUpCodes(SNOMEDCT) Specific follow up required for a procedure e.g. removal of sutures. | ||
Type | CodeableConcept | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
35. Procedure.note | |||
Definition | Any other notes and comments about the procedure. | ||
Control | 0..0* | ||
Type | Annotation | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
36. 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..0* | ||
Type | BackboneElement | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
37. Procedure.usedReference | |||
Definition | Identifies medications, devices and any other substance used as part of the procedure. | ||
Control | 0..0* | ||
Type | Reference(Device|Medication|Substance) | ||
Summary | false | ||
Requirements | Used for tracking contamination, etc. | ||
Comments | For devices actually implanted or removed, use Procedure.device. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
38. Procedure.usedCode | |||
Definition | Identifies coded items that were used as part of the procedure. | ||
Control | 0..0* | ||
Binding | For example codes, see FHIRDeviceTypes Codes describing items used during a procedure. | ||
Type | CodeableConcept | ||
Summary | false | ||
Comments | For devices actually implanted or removed, use Procedure.device. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. 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..* | ||||
Summary | false | ||||
2. 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 | ||||
Summary | true | ||||
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. | ||||
3. 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 | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
5. Procedure.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
6. 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 | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
7. 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 | ||||
Summary | false | ||||
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. | ||||
8. Procedure.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
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. | ||||
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()) | ||||
9. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
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. | ||||
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()) | ||||
10. Procedure.identifier | |||||
Definition | Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..0 | ||||
Type | Identifier | ||||
Summary | true | ||||
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 Person resource instances might share the same social insurance number. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
11. Procedure.instantiatesCanonical | |||||
Definition | The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. | ||||
Control | 0..0 | ||||
Type | canonical(PlanDefinition|ActivityDefinition|Measure|OperationDefinition|Questionnaire) | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
12. Procedure.instantiatesUri | |||||
Definition | The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. | ||||
Control | 0..0 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
13. Procedure.basedOn | |||||
Definition | A reference to a resource that contains details of the request for this procedure. | ||||
Control | 0..0 | ||||
Type | Reference(CarePlan|ServiceRequest) | ||||
Summary | true | ||||
Alternate Names | fulfills | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
14. Procedure.partOf | |||||
Definition | A larger event of which this particular procedure is a component or step. | ||||
Control | 0..0 | ||||
Type | Reference(Procedure|Observation|MedicationAdministration) | ||||
Summary | true | ||||
Alternate Names | container | ||||
Comments | The MedicationAdministration resource 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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
15. Procedure.status | |||||
Definition | A code specifying the state of the procedure. Generally, this will be the in-progress or completed state. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from EventStatus A code specifying the state of the procedure | ||||
Type | code | ||||
Is Modifier | true | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
16. Procedure.statusReason | |||||
Definition | Captures the reason for the current state of the procedure. | ||||
Control | 0..0 | ||||
Binding | For example codes, see ProcedureNotPerformedReason(SNOMED-CT) A code that identifies the reason a procedure was not performed | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
17. Procedure.category | |||||
Definition | A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). | ||||
Control | 0..0 | ||||
Binding | For example codes, see ProcedureCategoryCodes(SNOMEDCT) A code that classifies a procedure for searching, sorting and display purposes | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
18. 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 | 1..1 | ||||
Binding | For example codes, see ProcedureCodes(SNOMEDCT) A code to identify a specific procedure | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | 0..1 to account for primarily narrative only resources. | ||||
Alternate Names | type | ||||
19. 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 | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
20. 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 | ||||
Summary | false | ||||
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. | ||||
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()) | ||||
Slicing | This element introduces a set of slices on Procedure.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
21. Procedure.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Summary | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Procedure.code.coding. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
22. Procedure.code.coding:level2 | |||||
SliceName | level2 | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from FSIIICareInterventions | ||||
Type | Coding | ||||
Summary | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
23. Procedure.code.coding:level2.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 | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
24. Procedure.code.coding:level2.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 | ||||
Summary | false | ||||
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. | ||||
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()) | ||||
Slicing | This element introduces a set of slices on Procedure.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
25. Procedure.code.coding:level2.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Pattern Value | urn:oid:1.2.208.176.2.21 | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. Procedure.code.coding:level2.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. Procedure.code.coding:level2.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. Procedure.code.coding:level2.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
29. Procedure.code.coding:level2.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. Procedure.code.coding:level3 | |||||
SliceName | level3 | ||||
Definition | Shall contain locally defined code if it is a locally defined level 3 intervention | ||||
Control | 0..1 | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
31. Procedure.code.coding:level3.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 | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
32. Procedure.code.coding:level3.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 | ||||
Summary | false | ||||
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. | ||||
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()) | ||||
Slicing | This element introduces a set of slices on Procedure.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
33. Procedure.code.coding:level3.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Pattern Value | http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. Procedure.code.coding:level3.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. Procedure.code.coding:level3.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
36. Procedure.code.coding:level3.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. Procedure.code.coding:level3.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. Procedure.subject | |||||
Definition | The person, animal or group on which the procedure was performed. | ||||
Control | 1..1 | ||||
Type | Reference(KLGatewayCareCitizen) : {b} | ||||
Summary | true | ||||
Alternate Names | patient | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
40. Procedure.encounter | |||||
Definition | The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. | ||||
Control | 0..0 | ||||
Type | Reference(Encounter) | ||||
Summary | true | ||||
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
41. 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 | dateTime | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
42. Procedure.recorder | |||||
Definition | Individual who recorded the record and takes responsibility for its content. | ||||
Control | 0..0 | ||||
Type | Reference(Patient|RelatedPerson|Practitioner|PractitionerRole) | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
43. Procedure.asserter | |||||
Definition | Individual who is making the procedure statement. | ||||
Control | 0..0 | ||||
Type | Reference(Patient|RelatedPerson|Practitioner|PractitionerRole) | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. Procedure.performer | |||||
Definition | Limited to "real" people rather than equipment. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
45. Procedure.location | |||||
Definition | The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. | ||||
Control | 0..0 | ||||
Type | Reference(Location) | ||||
Summary | true | ||||
Requirements | Ties a procedure to where the records are likely kept. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. Procedure.reasonCode | |||||
Definition | The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text. | ||||
Control | 0..0 | ||||
Binding | For example codes, see ProcedureReasonCodes A code that identifies the reason a procedure is required | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
47. Procedure.reasonReference | |||||
Definition | Reason for this intervention. Must contain all conditions known to be addressed by this intervention | ||||
Control | 0..* | ||||
Type | Reference(KLGatewayCareCondition) : {b} | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as an epidural). Other examples include endoscopy for dilatation and biopsy (a combination of diagnostic and therapeutic use). 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
48. Procedure.bodySite | |||||
Definition | Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. | ||||
Control | 0..0 | ||||
Binding | For example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality | ||||
Type | CodeableConcept | ||||
Summary | 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
49. Procedure.outcome | |||||
Definition | The outcome of the procedure - did it resolve the reasons for the procedure being performed? | ||||
Control | 0..0 | ||||
Binding | For example codes, see ProcedureOutcomeCodes(SNOMEDCT) An outcome of a procedure - whether it was resolved or otherwise | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Comments | If outcome contains narrative text only, it can be captured using the CodeableConcept.text. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
50. Procedure.report | |||||
Definition | This could be a histology result, pathology report, surgical report, etc. | ||||
Control | 0..0 | ||||
Type | Reference(DiagnosticReport|DocumentReference|Composition) | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. 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..0 | ||||
Binding | For example codes, see Condition/Problem/DiagnosisCodes Codes describing complications that resulted from a procedure | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Comments | If complications are only expressed by the narrative text, they can be captured using the CodeableConcept.text. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
52. Procedure.complicationDetail | |||||
Definition | Any complications that occurred during the procedure, or in the immediate post-performance period. | ||||
Control | 0..0 | ||||
Type | Reference(Condition) | ||||
Summary | false | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
53. Procedure.followUp | |||||
Definition | If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used. | ||||
Control | 0..0 | ||||
Binding | For example codes, see ProcedureFollowUpCodes(SNOMEDCT) Specific follow up required for a procedure e.g. removal of sutures | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
54. Procedure.note | |||||
Definition | Any other notes and comments about the procedure. | ||||
Control | 0..0 | ||||
Type | Annotation | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
55. 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..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
56. Procedure.usedReference | |||||
Definition | Identifies medications, devices and any other substance used as part of the procedure. | ||||
Control | 0..0 | ||||
Type | Reference(Device|Medication|Substance) | ||||
Summary | false | ||||
Requirements | Used for tracking contamination, etc. | ||||
Comments | For devices actually implanted or removed, use Procedure.device. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
57. Procedure.usedCode | |||||
Definition | Identifies coded items that were used as part of the procedure. | ||||
Control | 0..0 | ||||
Binding | For example codes, see FHIRDeviceTypes Codes describing items used during a procedure | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Comments | For devices actually implanted or removed, use Procedure.device. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |