Release 4
Clinical SummaryThis page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Patient Care Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Encounter, Patient, Practitioner, RelatedPerson |
This is a representation of the json schema for Procedure, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/Procedure",
"$ref": "#/definitions/Procedure",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"Procedure": {
"description": "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.",
"properties": {
"resourceType": {
"description": "This is a Procedure resource",
"const": "Procedure"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "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.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"instantiatesCanonical": {
"description": "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.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"instantiatesUri": {
"description": "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.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_instantiatesUri": {
"description": "Extensions for instantiatesUri",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"basedOn": {
"description": "A reference to a resource that contains details of the request for this procedure.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"partOf": {
"description": "A larger event of which this particular procedure is a component or step.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"status": {
"description": "A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"statusReason": {
"description": "Captures the reason for the current state of the procedure.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"category": {
"description": "A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\").",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"code": {
"description": "The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\").",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"subject": {
"description": "The person, animal or group on which the procedure was performed.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"encounter": {
"description": "The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"performedDateTime": {
"description": "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.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$",
"type": "string"
},
"_performedDateTime": {
"description": "Extensions for performedDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"performedPeriod": {
"description": "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.",
"$ref": "Period.schema.json#/definitions/Period"
},
"performedString": {
"description": "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.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_performedString": {
"description": "Extensions for performedString",
"$ref": "Element.schema.json#/definitions/Element"
},
"performedAge": {
"description": "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.",
"$ref": "Age.schema.json#/definitions/Age"
},
"performedRange": {
"description": "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.",
"$ref": "Range.schema.json#/definitions/Range"
},
"recorder": {
"description": "Individual who recorded the record and takes responsibility for its content.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"asserter": {
"description": "Individual who is making the procedure statement.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"performer": {
"description": "Limited to \"real\" people rather than equipment.",
"items": {
"$ref": "#/definitions/Procedure_Performer"
},
"type": "array"
},
"location": {
"description": "The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"reasonCode": {
"description": "The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"reasonReference": {
"description": "The justification of why the procedure was performed.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"bodySite": {
"description": "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"outcome": {
"description": "The outcome of the procedure - did it resolve the reasons for the procedure being performed?",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"report": {
"description": "This could be a histology result, pathology report, surgical report, etc.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"complication": {
"description": "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 \u0027post procedure\u0027 issues.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"complicationDetail": {
"description": "Any complications that occurred during the procedure, or in the immediate post-performance period.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"followUp": {
"description": "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.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"note": {
"description": "Any other notes and comments about the procedure.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
},
"focalDevice": {
"description": "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.",
"items": {
"$ref": "#/definitions/Procedure_FocalDevice"
},
"type": "array"
},
"usedReference": {
"description": "Identifies medications, devices and any other substance used as part of the procedure.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"usedCode": {
"description": "Identifies coded items that were used as part of the procedure.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"subject",
"resourceType"
]
},
"Procedure_Performer": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 and/or the understanding of the containing element\u0027s 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 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"function": {
"description": "Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"actor": {
"description": "The practitioner who was involved in the procedure.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"onBehalfOf": {
"description": "The organization the device or practitioner was acting on behalf of.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"additionalProperties": false,
"required": [
"actor"
]
},
"Procedure_FocalDevice": {
"description": "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.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 and/or the understanding of the containing element\u0027s 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 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"action": {
"description": "The kind of change that happened to the device during the procedure.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"manipulated": {
"description": "The device that was manipulated (changed) during the procedure.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"additionalProperties": false,
"required": [
"manipulated"
]
}
}
}
®© HL7.org 2011+. FHIR Release 4 (Technical Correction #1) (v4.0.1) generated on Fri, Nov 1, 2019 09:36+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to R3 |
|
Propose a change