Procedure Profile
This Procedure profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.
Overview
This resource captures an action that was performed on a patient. This can range from physical interventions such as operations to the less invasive, such as counselling or hypnotherapy.
Scope and Usage
This profile is used to define the content that will be returned by the API Server in response to requests to access Procedure resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
Source
The Procedure resource is derived from the ORDERS tables in athenaPractice and athenaFlow, and includes only those orders that are for procedures. Specific detail can be found in the Mappings section below.
Supported Operations
The operations supported by this resource are listed below.
Read Operation
Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a Procedure, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/Procedure/[id]{?_format=[json|xml]&_summary=[true|data]}
Read Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the Procedure resource to retrieve |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides slightly improved API response times. |
Read Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Search Operation
Search operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Procedure resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/Procedure?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Search Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Procedure resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the AthenaHealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
| _id (token ) | The ID of the resource |
| _lastUpdated (date ) | |
| _lastUpdated-fromnow (quantity ) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time , e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| _security (token ) | |
| _tag (token ) | |
| code (token ) | A code to identify a procedure |
| date (date ) | Date/Period the procedure was performed |
| date-fromnow (quantity ) | Like date except expressed as a positive or negative offset from the current time in units of time , e.g. date-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| encounter (reference ) | The encounter associated with the procedure |
| identifier (token ) | A unique identifier for a procedure |
| patient (reference ) | Search by subject - a patient |
| performer (reference ) | The reference to the practitioner |
| status (token ) | |
| subject (reference ) | Search by subject |
Search Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/procedure-profile
An action that is being or was performed on a patient
| Name | Flags | Card. | Type | Description & Constraints | |
|---|---|---|---|---|---|
  Procedure | I | 0..* | Procedure | An action that is being or was performed on a patient pro-1: Reason not performed is only permitted if notPerformed indicator is true | |
 meta | S ∑ | 0..1 | Meta | Metadata about the resource | |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created | |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required ) | ||
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | ||
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
 identifier | S ∑ | 0..* | Identifier | External Identifiers for this procedure | |
 subject | S ∑ | 1..1 | Reference (Patient | Group ) | Who the procedure was performed on | |
| status | ?! ∑ | 1..1 | code | in-progress | aborted | completed | entered-in-error Binding: ProcedureStatus (required ) | |
| category | ∑ | 0..1 | CodeableConcept | Classification of the procedure Binding: Procedure Category Codes (SNOMED CT) (example ) | |
| code | ∑ | 1..1 | CodeableConcept | Identification of the procedure Binding: Procedure Codes (SNOMED CT) (example ) | |
| notPerformed | ?! | 0..1 | boolean | True if procedure was not performed as scheduled | |
| reasonNotPerformed | I | 0..* | CodeableConcept | Reason procedure was not performed Binding: Procedure Not Performed Reason (SNOMED-CT) (example ) | |
| bodySite | ∑ | 0..* | CodeableConcept | Target body sites Binding: SNOMED CT Body Structures (example ) | |
| reasonReference | ∑ | 0..1 | Reference (Condition ) | Reason procedure performed Binding: Procedure Reason Codes (example ) | |
| performer | ∑ | 0..* | BackboneElement | The people who performed the procedure | |
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| actor | ∑ | 0..1 | Reference (Practitioner | Organization | Patient | RelatedPerson ) | The reference to the practitioner | |
 role | ∑ | 0..1 | CodeableConcept | The role the actor was in Binding: Procedure Performer Role Codes (example ) | |
| performedDateTime | S ∑ | 0..1 | dateTime | Date/Period the procedure was performed | |
| encounter | S ∑ | 0..1 | Reference (Encounter ) | The encounter associated with the procedure | |
| location | ∑ | 0..1 | Reference (Location ) | Where the procedure happened | |
| outcome | ∑ | 0..1 | CodeableConcept | The result of procedure Binding: Procedure Outcome Codes (SNOMED CT) (example ) | |
| report | 0..* | Reference (DiagnosticReport ) | Any report resulting from the procedure | ||
| complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/Diagnosis Codes (example ) | ||
| followUp | 0..* | CodeableConcept | Instructions for follow up Binding: Procedure Follow up Codes (SNOMED CT) (example ) | ||
| request | S | 0..1 | Reference (ProcedureRequest ) | Reference to the procedure request | |
| notes | 0..* | Annotation | Additional information about the procedure | ||
| focalDevice | 0..* | BackboneElement | Device changed in procedure | ||
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| action | 0..1 | CodeableConcept | Kind of change to device Binding: Procedure Device Action Codes (required ) | ||
| manipulated | 1..1 | Reference (Device ) | Device that was changed | ||
| used | 0..* | Reference (Device | Medication | Substance ) | Items used during procedure | ||
athenaFlow Mapping
The mappings in this section represent the how data stored within athenaFlow is served through the product's APIs.
Use of this information is subject to the API Server
Terms and Conditions .
| Procedure Profile | ||
| Procedure | Procedure-Profile | FHIR_PROCEDUREVIEW |
| ├ id | %ORDGROUPID% | |
| ├ identifier | MakeIdentifier("U",getSiteSystem("ORDERNUM"),%ORDERNUM%) | |
| ├ subject | MakeReference("PERSON",%PID%,"Patient") | |
| ├ status | MapCode(%STATUS%,"PROCEDURESTATUS") | |
| ├ category | MakeCategory(%CODE%, "http://snomed.info/sct", "Radiation oncology AND/OR radiotherapy") | |
| ├ code | MakeOrderCodeConcept(%CODE%, %DESCRIPTION%,%SYSTEM%) | |
| ├ notPerformed | false | |
| ├ reasonNotPerformed | MakeTextConcept(%CANCELREASON%) | |
| ├ reasonReference | MakeReference("PROBLEM",%SPRID%,"Condition") | |
| │ └ actor | MakeReference("USR",%PERFORMER%,"Practitioner") | |
| ├ performedDateTime | %COMPLETED_DT% | |
| ├ encounter | MakeReference("DOCUMENT",%SDID%,"Encounter") | |
| └ request | MakeReference("ORDERS",%ORDGROUPID%,"ProcedureRequest") | |