procedure requests

Create Procedure Request

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

A record of a request for diagnostic investigations, treatments, or operations to be performed.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringProcedureRequestThis is a ProcedureRequest resource
identifierarray(Identifier)Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
definitionarray(Reference)Protocol or definition followed by this request.
basedOnarray(Reference)Plan/proposal/order fulfilled by this request.
replacesarray(Reference)The request takes the place of the referenced completed or terminated request(s).
requisitionIdentifierA shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
statusstringThe status of the order.
intentstringWhether the request is a proposal, plan, an original order or a reflex order.
prioritystringIndicates how quickly the ProcedureRequest should be addressed with respect to other requests.
doNotPerformbooleanSet this to true if the record is saying that the procedure should NOT be performed.
categoryarray(CodeableConcept)A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
code*CodeableConceptA code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.
subject*ReferenceOn whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
contextReferenceAn encounter or episode of care that provides additional information about the healthcare context in which this request is made.
occurrenceDateTimestringThe date/time at which the diagnostic testing should occur.
occurrencePeriodPeriodThe date/time at which the diagnostic testing should occur.
occurrenceTimingTimingThe date/time at which the diagnostic testing should occur.
asNeededBooleanbooleanIf a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.
asNeededCodeableConceptCodeableConceptIf a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.
authoredOnstringWhen the request transitioned to being actionable.
requesterProcedureRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.
reasonCodearray(CodeableConcept)An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
reasonReferencearray(Reference)Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.
supportingInfoarray(Reference)Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
specimenarray(Reference)One or more specimens that the laboratory procedure will use.
bodySitearray(CodeableConcept)Anatomic location where the procedure should be performed. This is the target site.
notearray(Annotation)Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions.
relevantHistoryarray(Reference)Key events in the history of the request.

Response

Patch Procedure Request

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

A record of a request for diagnostic investigations, treatments, or operations to be performed.

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*stringProcedureRequestThis is a ProcedureRequest resource
identifierarray(Identifier)Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
definitionarray(Reference)Protocol or definition followed by this request.
basedOnarray(Reference)Plan/proposal/order fulfilled by this request.
replacesarray(Reference)The request takes the place of the referenced completed or terminated request(s).
requisitionIdentifierA shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
statusstringThe status of the order.
intentstringWhether the request is a proposal, plan, an original order or a reflex order.
prioritystringIndicates how quickly the ProcedureRequest should be addressed with respect to other requests.
doNotPerformbooleanSet this to true if the record is saying that the procedure should NOT be performed.
categoryarray(CodeableConcept)A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
code*CodeableConceptA code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.
subject*ReferenceOn whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
contextReferenceAn encounter or episode of care that provides additional information about the healthcare context in which this request is made.
occurrenceDateTimestringThe date/time at which the diagnostic testing should occur.
occurrencePeriodPeriodThe date/time at which the diagnostic testing should occur.
occurrenceTimingTimingThe date/time at which the diagnostic testing should occur.
asNeededBooleanbooleanIf a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.
asNeededCodeableConceptCodeableConceptIf a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.
authoredOnstringWhen the request transitioned to being actionable.
requesterProcedureRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.
reasonCodearray(CodeableConcept)An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
reasonReferencearray(Reference)Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.
supportingInfoarray(Reference)Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
specimenarray(Reference)One or more specimens that the laboratory procedure will use.
bodySitearray(CodeableConcept)Anatomic location where the procedure should be performed. This is the target site.
notearray(Annotation)Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions.
relevantHistoryarray(Reference)Key events in the history of the request.

Response

Read Procedure Request

get
/organizations/{organizationId}/fhir/3/ProcedureRequest/{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 Request

get
/organizations/{organizationId}/fhir/3/ProcedureRequest/{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 Request

get
/organizations/{organizationId}/fhir/3/ProcedureRequest/{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 Request

delete
/organizations/{organizationId}/fhir/3/ProcedureRequest/{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 Request

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

Request

Headers

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

Query params

_idstring
_languagestring
authoredstring
based-onstring
body-sitestring
codestring
contextstring
definitionstring
encounterstring
identifierstring
intentstring
occurrencestring
patientstring
performerstring
performer-typestring
pertains-tostring
prioritystring
reasonstring
reason-codestring
replacesstring
requesterstring
requisitionstring
specimenstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Procedure Request

get
/organizations/{organizationId}/fhir/3/ProcedureRequest/_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 Request

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

A record of a request for diagnostic investigations, treatments, or operations to be performed.

Request

Headers

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

Query params

_idstring
_languagestring
authoredstring
based-onstring
body-sitestring
codestring
contextstring
definitionstring
encounterstring
identifierstring
intentstring
occurrencestring
patientstring
performerstring
performer-typestring
pertains-tostring
prioritystring
reasonstring
reason-codestring
replacesstring
requesterstring
requisitionstring
specimenstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringProcedureRequestThis is a ProcedureRequest resource
identifierarray(Identifier)Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
definitionarray(Reference)Protocol or definition followed by this request.
basedOnarray(Reference)Plan/proposal/order fulfilled by this request.
replacesarray(Reference)The request takes the place of the referenced completed or terminated request(s).
requisitionIdentifierA shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
statusstringThe status of the order.
intentstringWhether the request is a proposal, plan, an original order or a reflex order.
prioritystringIndicates how quickly the ProcedureRequest should be addressed with respect to other requests.
doNotPerformbooleanSet this to true if the record is saying that the procedure should NOT be performed.
categoryarray(CodeableConcept)A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
code*CodeableConceptA code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.
subject*ReferenceOn whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
contextReferenceAn encounter or episode of care that provides additional information about the healthcare context in which this request is made.
occurrenceDateTimestringThe date/time at which the diagnostic testing should occur.
occurrencePeriodPeriodThe date/time at which the diagnostic testing should occur.
occurrenceTimingTimingThe date/time at which the diagnostic testing should occur.
asNeededBooleanbooleanIf a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.
asNeededCodeableConceptCodeableConceptIf a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.
authoredOnstringWhen the request transitioned to being actionable.
requesterProcedureRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.
reasonCodearray(CodeableConcept)An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
reasonReferencearray(Reference)Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.
supportingInfoarray(Reference)Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
specimenarray(Reference)One or more specimens that the laboratory procedure will use.
bodySitearray(CodeableConcept)Anatomic location where the procedure should be performed. This is the target site.
notearray(Annotation)Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions.
relevantHistoryarray(Reference)Key events in the history of the request.

Response

Update Procedure Request

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

A record of a request for diagnostic investigations, treatments, or operations to be performed.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringProcedureRequestThis is a ProcedureRequest resource
identifierarray(Identifier)Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
definitionarray(Reference)Protocol or definition followed by this request.
basedOnarray(Reference)Plan/proposal/order fulfilled by this request.
replacesarray(Reference)The request takes the place of the referenced completed or terminated request(s).
requisitionIdentifierA shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
statusstringThe status of the order.
intentstringWhether the request is a proposal, plan, an original order or a reflex order.
prioritystringIndicates how quickly the ProcedureRequest should be addressed with respect to other requests.
doNotPerformbooleanSet this to true if the record is saying that the procedure should NOT be performed.
categoryarray(CodeableConcept)A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
code*CodeableConceptA code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.
subject*ReferenceOn whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
contextReferenceAn encounter or episode of care that provides additional information about the healthcare context in which this request is made.
occurrenceDateTimestringThe date/time at which the diagnostic testing should occur.
occurrencePeriodPeriodThe date/time at which the diagnostic testing should occur.
occurrenceTimingTimingThe date/time at which the diagnostic testing should occur.
asNeededBooleanbooleanIf a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.
asNeededCodeableConceptCodeableConceptIf a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.
authoredOnstringWhen the request transitioned to being actionable.
requesterProcedureRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.
reasonCodearray(CodeableConcept)An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
reasonReferencearray(Reference)Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.
supportingInfoarray(Reference)Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
specimenarray(Reference)One or more specimens that the laboratory procedure will use.
bodySitearray(CodeableConcept)Anatomic location where the procedure should be performed. This is the target site.
notearray(Annotation)Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions.
relevantHistoryarray(Reference)Key events in the history of the request.

Response