procedures

Create Procedure

post
/organizations/{organizationId}/fhir/3/Procedure

An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringProcedureThis is a Procedure resource
identifierarray(Identifier)This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definitionarray(Reference)A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.
basedOnarray(Reference)A reference to a resource that contains details of the request for this procedure.
partOfarray(Reference)A larger event of which this particular procedure is a component or step.
statusstringA code specifying the state of the procedure. Generally this will be in-progress or completed state.
notDonebooleanSet this to true if the record is saying that the procedure was NOT performed.
notDoneReasonCodeableConceptA code indicating why the procedure was not performed.
categoryCodeableConceptA code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
codeCodeableConceptThe specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
subject*ReferenceThe person, animal or group on which the procedure was performed.
contextReferenceThe encounter during which the procedure was performed.
performedDateTimestringThe date(time)/period over which 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.
performedPeriodPeriodThe date(time)/period over which 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.
performerarray(Procedure_Performer)Limited to 'real' people rather than equipment.
locationReferenceThe location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
reasonCodearray(CodeableConcept)The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.
reasonReferencearray(Reference)The condition that is the reason why the procedure was performed.
bodySitearray(CodeableConcept)Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
outcomeCodeableConceptThe outcome of the procedure - did it resolve reasons for the procedure being performed?
reportarray(Reference)This could be a histology result, pathology report, surgical report, etc..
complicationarray(CodeableConcept)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.
complicationDetailarray(Reference)Any complications that occurred during the procedure, or in the immediate post-performance period.
followUparray(CodeableConcept)If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used.
notearray(Annotation)Any other notes about the procedure. E.g. the operative notes.
focalDevicearray(Procedure_FocalDevice)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.
usedReferencearray(Reference)Identifies medications, devices and any other substance used as part of the procedure.
usedCodearray(CodeableConcept)Identifies coded items that were used as part of the procedure.

Response

Patch Procedure

patch
/organizations/{organizationId}/fhir/3/Procedure/{resourceId}

An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringProcedureThis is a Procedure resource
identifierarray(Identifier)This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definitionarray(Reference)A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.
basedOnarray(Reference)A reference to a resource that contains details of the request for this procedure.
partOfarray(Reference)A larger event of which this particular procedure is a component or step.
statusstringA code specifying the state of the procedure. Generally this will be in-progress or completed state.
notDonebooleanSet this to true if the record is saying that the procedure was NOT performed.
notDoneReasonCodeableConceptA code indicating why the procedure was not performed.
categoryCodeableConceptA code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
codeCodeableConceptThe specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
subject*ReferenceThe person, animal or group on which the procedure was performed.
contextReferenceThe encounter during which the procedure was performed.
performedDateTimestringThe date(time)/period over which 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.
performedPeriodPeriodThe date(time)/period over which 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.
performerarray(Procedure_Performer)Limited to 'real' people rather than equipment.
locationReferenceThe location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
reasonCodearray(CodeableConcept)The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.
reasonReferencearray(Reference)The condition that is the reason why the procedure was performed.
bodySitearray(CodeableConcept)Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
outcomeCodeableConceptThe outcome of the procedure - did it resolve reasons for the procedure being performed?
reportarray(Reference)This could be a histology result, pathology report, surgical report, etc..
complicationarray(CodeableConcept)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.
complicationDetailarray(Reference)Any complications that occurred during the procedure, or in the immediate post-performance period.
followUparray(CodeableConcept)If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used.
notearray(Annotation)Any other notes about the procedure. E.g. the operative notes.
focalDevicearray(Procedure_FocalDevice)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.
usedReferencearray(Reference)Identifies medications, devices and any other substance used as part of the procedure.
usedCodearray(CodeableConcept)Identifies coded items that were used as part of the procedure.

Response

Read Procedure

get
/organizations/{organizationId}/fhir/3/Procedure/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Procedure

get
/organizations/{organizationId}/fhir/3/Procedure/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Procedure

get
/organizations/{organizationId}/fhir/3/Procedure/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Procedure

delete
/organizations/{organizationId}/fhir/3/Procedure/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Procedure

get
/organizations/{organizationId}/fhir/3/Procedure

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
based-onstring
categorystring
codestring
contextstring
datestring
definitionstring
encounterstring
identifierstring
locationstring
part-ofstring
patientstring
performerstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Procedure

get
/organizations/{organizationId}/fhir/3/Procedure/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Procedure

post
/organizations/{organizationId}/fhir/3/Procedure/_search

An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
based-onstring
categorystring
codestring
contextstring
datestring
definitionstring
encounterstring
identifierstring
locationstring
part-ofstring
patientstring
performerstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringProcedureThis is a Procedure resource
identifierarray(Identifier)This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definitionarray(Reference)A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.
basedOnarray(Reference)A reference to a resource that contains details of the request for this procedure.
partOfarray(Reference)A larger event of which this particular procedure is a component or step.
statusstringA code specifying the state of the procedure. Generally this will be in-progress or completed state.
notDonebooleanSet this to true if the record is saying that the procedure was NOT performed.
notDoneReasonCodeableConceptA code indicating why the procedure was not performed.
categoryCodeableConceptA code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
codeCodeableConceptThe specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
subject*ReferenceThe person, animal or group on which the procedure was performed.
contextReferenceThe encounter during which the procedure was performed.
performedDateTimestringThe date(time)/period over which 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.
performedPeriodPeriodThe date(time)/period over which 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.
performerarray(Procedure_Performer)Limited to 'real' people rather than equipment.
locationReferenceThe location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
reasonCodearray(CodeableConcept)The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.
reasonReferencearray(Reference)The condition that is the reason why the procedure was performed.
bodySitearray(CodeableConcept)Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
outcomeCodeableConceptThe outcome of the procedure - did it resolve reasons for the procedure being performed?
reportarray(Reference)This could be a histology result, pathology report, surgical report, etc..
complicationarray(CodeableConcept)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.
complicationDetailarray(Reference)Any complications that occurred during the procedure, or in the immediate post-performance period.
followUparray(CodeableConcept)If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used.
notearray(Annotation)Any other notes about the procedure. E.g. the operative notes.
focalDevicearray(Procedure_FocalDevice)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.
usedReferencearray(Reference)Identifies medications, devices and any other substance used as part of the procedure.
usedCodearray(CodeableConcept)Identifies coded items that were used as part of the procedure.

Response

Update Procedure

put
/organizations/{organizationId}/fhir/3/Procedure/{resourceId}

An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringProcedureThis is a Procedure resource
identifierarray(Identifier)This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definitionarray(Reference)A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.
basedOnarray(Reference)A reference to a resource that contains details of the request for this procedure.
partOfarray(Reference)A larger event of which this particular procedure is a component or step.
statusstringA code specifying the state of the procedure. Generally this will be in-progress or completed state.
notDonebooleanSet this to true if the record is saying that the procedure was NOT performed.
notDoneReasonCodeableConceptA code indicating why the procedure was not performed.
categoryCodeableConceptA code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
codeCodeableConceptThe specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
subject*ReferenceThe person, animal or group on which the procedure was performed.
contextReferenceThe encounter during which the procedure was performed.
performedDateTimestringThe date(time)/period over which 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.
performedPeriodPeriodThe date(time)/period over which 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.
performerarray(Procedure_Performer)Limited to 'real' people rather than equipment.
locationReferenceThe location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
reasonCodearray(CodeableConcept)The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.
reasonReferencearray(Reference)The condition that is the reason why the procedure was performed.
bodySitearray(CodeableConcept)Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
outcomeCodeableConceptThe outcome of the procedure - did it resolve reasons for the procedure being performed?
reportarray(Reference)This could be a histology result, pathology report, surgical report, etc..
complicationarray(CodeableConcept)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.
complicationDetailarray(Reference)Any complications that occurred during the procedure, or in the immediate post-performance period.
followUparray(CodeableConcept)If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used.
notearray(Annotation)Any other notes about the procedure. E.g. the operative notes.
focalDevicearray(Procedure_FocalDevice)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.
usedReferencearray(Reference)Identifies medications, devices and any other substance used as part of the procedure.
usedCodearray(CodeableConcept)Identifies coded items that were used as part of the procedure.

Response