FHIR Procedure
- Pete Richardson
- Melissa Morley
The following is a description of a Procedure that can be submitted to the Community of Information Exchange. This will represent interventions (term used by the gravity project https://confluence.hl7.org/display/GRAV/The+Gravity+Project ) that are given to the patient. For detailed information please visit the HL7 FHIR page https://www.hl7.org/fhir/R4/procedure.html
Operations
The following are operations that can be performed and links to
Get a FHIR Procedure by patient Id
Submit more than one Procedure at time (Bundle)
Sample Procedure Object
{
"basedOn": [
{
"reference": "ServiceRequest/cb19befb-1234-441d-a3ba-e4f3564ad8a9",
"type": "ServiceRequest"
}
],
"category": {
"coding": [
{
"code": "service-category",
"display": "service category",
"system": "https://mi-cie.org"
}
],
"text": "Clothing & Household Goods"
},
"code": {
"coding": [
{
"code": "SocialServiceReferral_v2",
"display": "Social Service Referred",
"system": "https://mi-cie.org"
}
],
"text": "Email"
},
"extension": [
{
"url": "https://mi-cie.org/fhir/StructureDefinition/HealthcareServiceId",
"valueInteger": 176000
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/HealthcareServiceLocationName",
"valueString": "SAINT LUKE'S EPISCOPAL CHURCH"
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/HealthcareServiceName",
"valueString": "DIAPERS"
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/AttemptToUse",
"valueString": "Not Yet"
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/HelpProvided",
"valueString": ""
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/taxonomyId",
"valueString": ""
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/taxonomyName",
"valueString": ""
},
{
"url": "https://mi-cie.org/fhir/StructureDefinition/searchZipCode",
"valueString": "49009"
}
],
"id": "aab0d98d-d9d5-1234-96ef-a120916c8e51",
"meta": {
"lastUpdated": "2024-07-30T20:46:28.552960+00:00",
"versionId": "MTcyMjM3MjM4ODU1Mjk2MDAwMA"
},
"note": [
{
"authorReference": {
"display": "Kayla Jennings",
"reference": "Practitioner/a979df85-8ac2-4f93-8809-95208b800f87"
},
"text": "",
"time": "2024-07-30T16:46:27-04:00"
}
],
"performedDateTime": "2024-07-08T14:05:44-04:00",
"recorder": {
"display": "Kayla Jennings",
"reference": "Practitioner/a979df85-8ac2-4f93-8809-95208b800f87"
},
"resourceType": "Procedure",
"status": "in-progress",
"subject": {
"display": "FIRSTNAME LASTNAME",
"reference": "Patient/12345be5-3829-4d79-aadd-83afd44adc2c"
}
}Field DescriptionsThe following are descriptions of the most important values that must be passed
Field | Description | References | Â |
|---|---|---|---|
 identifier | This will be any custom client identifiers that can be passed to the CIE for reporting and also link to patient id. |  https://www.hl7.org/fhir/R4/procedure-definitions.html#Procedure.identifier | identifier_x_system identifier_x_type_text identifier_x_use identifier_x_value |
 category | This is a array of coded classifications on the procedure that is being performed. It contains metadata for the procedure. |  https://www.hl7.org/fhir/R4/procedure-definitions.html#Procedure.category | category_coding_0_code category_coding_0_display category_coding_0_system category_text |
code | This is a code on what procedure was given to the patient. | https://www.hl7.org/fhir/R4/procedure-definitions.html#Procedure.code | code_coding_0_code code_coding_0_display code_coding_0_system code_text |
subject | This is the patient identifier which the procedure. | https://build.fhir.org/procedure-definitions.html#Procedure.subject | subject_display subject_patientId |
note | Any notes that will be passed on the procedure. | https://www.hl7.org/fhir/R4/procedure-definitions.html#Procedure.note | note_x_author_reference_display note_x_author_reference_practitionerId note_x_text note_x_time |
performer | This is the organization that has provided the procedure. | https://www.hl7.org/fhir/R4/procedure-definitions.html#Procedure.performer | Â |
status | The status of the procedure | https://build.fhir.org/procedure-definitions.html#Procedure.status | status |
basedOn | This will contain any resources that the procedure will be basedOn. For example this could contain the ServiceRequest that started the process off or a CIE task that was created. This is a good field to link the procedure to a ServiceRequest. | https://build.fhir.org/procedure-definitions.html#Procedure.basedOn | basedOn_0_serviceRequestId |
id | Â | Â | Â |
recorder | The recorder is the system or person who has recorded the intervention. For example it could the social navigator that did the referral for a social service, or it could be | Â | recorder_display recorder_practitionerId |
performedDateTime | The in which the intervention occurred. | Â | performed_dateTime |
Data for intervention type | |||
extension. | This is the id of the service that was referred from the social naviagator | Â | HealthcareServiceId_0_value_integer |
extension. | This is the location name of the service that was referred from the social naviagator | Â | HealthcareServiceLocationName_0_value_string |
extension. | This is the name of the service that was referred | Â | HealthcareServiceName_0_value_string |
extension. | Was help provided to the client. | Â | HelpProvided_0_value_string |
extension. | This represents the zip code that was searched for the Service by the Social Navigator. | Â | searchZipCode_0_value_string |
extension. | This represents the taxonomy id that was searched for the Service by Social Navigator | Â | taxonomyId_0_value_string |
extension. | This represents the Name of the Taxonomy that was searched for the service that was referred by Social Naviagator. | Â | taxonomyName_0_value_string |