Publish Box goes here
Resource Profile: Profile - Athena Procedure
| Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-procedure-profile | Version: 23.1.0 | |||
| Active as of 2022-03-01 | Computable Name: AthenaProcedure | |||
athena procedure profile
This Procedure profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow 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 and includes only those orders that are for procedures. Specific detail can be found in the Mappings tab in the profile detail page.
Usage:
- Examples for this Resource Profile: Procedure/Example1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Procedure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |
  id |
1..1 | id | Logical id of this artifact | |
  meta |
0..1 | Meta | Metadata about the resource | |
 versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource version last changed | |
 Slices for profile |
2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
  profile:USCore Procedure Profile |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure | |
 profile:Athena Procedure Profile |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-procedure-profile | |
| Slices for security |
0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
| security:SENSITIVECHART |
0..1 | Coding | Security Labels applied to this resource | |
 security:CONFABBR |
0..1 | Coding | Security Labels applied to this resource | |
  system |
1..1 | uri | Identity of the terminology system | |
 code |
1..1 | code | Symbol in syntax defined by the system | |
| security:LOCATION |
0..1 | Coding | Security Labels applied to this resource | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
 security:CONFTYPEID |
0..1 | Coding | Security Labels applied to this resource | |
 system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
 tag |
1..2 | Coding | Tags applied to this resource | |
| identifier |
0..* | Identifier | External Identifiers for this procedure | |
 basedOn |
0..* | Reference(ServiceRequest) | Reference to the Service request | |
| status |
S | 1..1 | code | in-progress | aborted | completed | entered-in-error |
| statusReason |
0..1 | CodeableConcept | Reason for current status | |
| code |
S | 1..1 | CodeableConcept | Identification of the procedure |
| subject |
S | 1..1 | Reference(Patient | Group) | Who the procedure was performed on |
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of | |
| performed[x] |
S | 0..1 | dateTime | When the procedure was performed |
 performer |
0..* | BackboneElement | The people who performed the procedure | |
| actor |
0..1 | Reference(Practitioner | Organization | Patient | RelatedPerson) | The reference to the practitioner | |
| reasonReference |
0..1 | Reference(Condition) | The justification that the procedure was performed | |
| note |
0..* | Annotation | Additional information about the procedure | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |
| id |
Σ | 1..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| versionId |
Σ | 0..1 | id | Version specific identifier |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| Slices for profile |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
| profile:USCore Procedure Profile |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure |
| profile:Athena Procedure Profile |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-procedure-profile |
| Slices for security |
Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| security:SENSITIVECHART |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| security:CONFABBR |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| security:LOCATION |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| security:CONFTYPEID |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| tag |
Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | External Identifiers for this procedure |
| basedOn |
Σ | 0..* | Reference(ServiceRequest) | Reference to the Service request |
| status |
?!SΣ | 1..1 | code | in-progress | aborted | completed | entered-in-error Binding: EventStatus (required): A code specifying the state of the procedure. |
| statusReason |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. |
| code |
SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure . |
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who the procedure was performed on |
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
| performed[x] |
SΣ | 0..1 | dateTime | When the procedure was performed |
| performer |
Σ | 0..* | BackboneElement | The people who performed the procedure |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
Σ | 0..1 | Reference(Practitioner | Organization | Patient | RelatedPerson) | The reference to the practitioner |
| reasonReference |
Σ | 0..1 | Reference(Condition) | The justification that the procedure was performed |
| note |
0..* | Annotation | Additional information about the procedure | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Procedure.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.security:LOCATION | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.security:CONFTYPEID | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | |
| Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reasonfrom the FHIR Standard | |
| Procedure.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |||||
| id |
Σ | 1..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
| profile:USCore Procedure Profile |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure | ||||
| profile:Athena Procedure Profile |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-procedure-profile | ||||
| Slices for security |
Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| security:SENSITIVECHART |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| security:CONFABBR |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| security:LOCATION |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| security:CONFTYPEID |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| tag |
Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
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 |
Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(ServiceRequest) | Reference to the Service request | ||||
| partOf |
Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
| status |
?!SΣ | 1..1 | code | in-progress | aborted | completed | entered-in-error Binding: EventStatus (required): A code specifying the state of the procedure. | ||||
| statusReason |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
| category |
Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure . | ||||
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who the procedure was performed on | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| performed[x] |
SΣ | 0..1 | dateTime | When the procedure was performed | ||||
| recorder |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
| asserter |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
| performer |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
| actor |
Σ | 0..1 | Reference(Practitioner | Organization | Patient | RelatedPerson) | The reference to the practitioner | ||||
| onBehalfOf |
0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |||||
| location |
Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
| reasonReference |
Σ | 0..1 | Reference(Condition) | The justification that the procedure was performed | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| outcome |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
| report |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
| complication |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
| complicationDetail |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
| followUp |
0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
| note |
0..* | Annotation | Additional information about the procedure | |||||
| focalDevice |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| action |
0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
| manipulated |
1..1 | Reference(Device) | Device that was changed | |||||
| usedReference |
0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
| usedCode |
0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Procedure.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.security:LOCATION | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.security:CONFTYPEID | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Procedure.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | ||||
| Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reasonfrom the FHIR Standard | ||||
| Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-categoryfrom the FHIR Standard | ||||
| Procedure.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcomefrom the FHIR Standard | ||||
| Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followupfrom the FHIR Standard | ||||
| Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-actionfrom the FHIR Standard | ||||
| Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindfrom the FHIR Standard |
This structure is derived from Procedure
Summary
Mandatory: 4 elements(9 nested mandatory elements)
Must-Support: 4 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Procedure.meta.profile
- The element 1 is sliced based on the value of Procedure.meta.security
Differential View
This structure is derived from Procedure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |
| id |
1..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| Slices for profile |
2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
| profile:USCore Procedure Profile |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure | |
| profile:Athena Procedure Profile |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-procedure-profile | |
| Slices for security |
0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
| security:SENSITIVECHART |
0..1 | Coding | Security Labels applied to this resource | |
| security:CONFABBR |
0..1 | Coding | Security Labels applied to this resource | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| security:LOCATION |
0..1 | Coding | Security Labels applied to this resource | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| security:CONFTYPEID |
0..1 | Coding | Security Labels applied to this resource | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| tag |
1..2 | Coding | Tags applied to this resource | |
| identifier |
0..* | Identifier | External Identifiers for this procedure | |
| basedOn |
0..* | Reference(ServiceRequest) | Reference to the Service request | |
| status |
S | 1..1 | code | in-progress | aborted | completed | entered-in-error |
| statusReason |
0..1 | CodeableConcept | Reason for current status | |
| code |
S | 1..1 | CodeableConcept | Identification of the procedure |
| subject |
S | 1..1 | Reference(Patient | Group) | Who the procedure was performed on |
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of | |
| performed[x] |
S | 0..1 | dateTime | When the procedure was performed |
| performer |
0..* | BackboneElement | The people who performed the procedure | |
| actor |
0..1 | Reference(Practitioner | Organization | Patient | RelatedPerson) | The reference to the practitioner | |
| reasonReference |
0..1 | Reference(Condition) | The justification that the procedure was performed | |
| note |
0..* | Annotation | Additional information about the procedure | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |
| id |
Σ | 1..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| versionId |
Σ | 0..1 | id | Version specific identifier |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| Slices for profile |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
| profile:USCore Procedure Profile |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure |
| profile:Athena Procedure Profile |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-procedure-profile |
| Slices for security |
Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| security:SENSITIVECHART |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| security:CONFABBR |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| security:LOCATION |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| security:CONFTYPEID |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| tag |
Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | External Identifiers for this procedure |
| basedOn |
Σ | 0..* | Reference(ServiceRequest) | Reference to the Service request |
| status |
?!SΣ | 1..1 | code | in-progress | aborted | completed | entered-in-error Binding: EventStatus (required): A code specifying the state of the procedure. |
| statusReason |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. |
| code |
SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure . |
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who the procedure was performed on |
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
| performed[x] |
SΣ | 0..1 | dateTime | When the procedure was performed |
| performer |
Σ | 0..* | BackboneElement | The people who performed the procedure |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
Σ | 0..1 | Reference(Practitioner | Organization | Patient | RelatedPerson) | The reference to the practitioner |
| reasonReference |
Σ | 0..1 | Reference(Condition) | The justification that the procedure was performed |
| note |
0..* | Annotation | Additional information about the procedure | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Procedure.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.security:LOCATION | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.security:CONFTYPEID | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Procedure.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | |
| Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reasonfrom the FHIR Standard | |
| Procedure.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |||||
| id |
Σ | 1..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
| profile:USCore Procedure Profile |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure | ||||
| profile:Athena Procedure Profile |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-procedure-profile | ||||
| Slices for security |
Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| security:SENSITIVECHART |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| security:CONFABBR |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| security:LOCATION |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| security:CONFTYPEID |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| tag |
Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
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 |
Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(ServiceRequest) | Reference to the Service request | ||||
| partOf |
Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
| status |
?!SΣ | 1..1 | code | in-progress | aborted | completed | entered-in-error Binding: EventStatus (required): A code specifying the state of the procedure. | ||||
| statusReason |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
| category |
Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure . | ||||
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who the procedure was performed on | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| performed[x] |
SΣ | 0..1 | dateTime | When the procedure was performed | ||||
| recorder |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
| asserter |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
| performer |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
| actor |
Σ | 0..1 | Reference(Practitioner | Organization | Patient | RelatedPerson) | The reference to the practitioner | ||||
| onBehalfOf |
0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |||||
| location |
Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
| reasonReference |
Σ | 0..1 | Reference(Condition) | The justification that the procedure was performed | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| outcome |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
| report |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
| complication |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
| complicationDetail |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
| followUp |
0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
| note |
0..* | Annotation | Additional information about the procedure | |||||
| focalDevice |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| action |
0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
| manipulated |
1..1 | Reference(Device) | Device that was changed | |||||
| usedReference |
0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
| usedCode |
0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Procedure.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.security:LOCATION | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.security:CONFTYPEID | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Procedure.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Procedure.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | ||||
| Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reasonfrom the FHIR Standard | ||||
| Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-categoryfrom the FHIR Standard | ||||
| Procedure.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcomefrom the FHIR Standard | ||||
| Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followupfrom the FHIR Standard | ||||
| Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-actionfrom the FHIR Standard | ||||
| Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindfrom the FHIR Standard |
This structure is derived from Procedure
Summary
Mandatory: 4 elements(9 nested mandatory elements)
Must-Support: 4 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Procedure.meta.profile
- The element 1 is sliced based on the value of Procedure.meta.security
Other representations of profile: CSV, Excel, Schematron
Notes:
Supported Interactions
Interactions supported by this resource are listed below.
Search Operation
Search parameters 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/r4/Procedure?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Where:
| Name | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/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 |
HTTP Response Codes
The following HTTP response codes are returned by this API call:
| 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. |