Athena Core Implementation Guide
4.2.0 - release

Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: athenahealth Procedure

Official URL: https://fhir.athena.io/StructureDefinition/ah-procedure Version: 4.2.0
Active as of 2025-04-17 Computable Name: AthenahealthProcedure
Keywords: Wire Format

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

This resource is used to record the details of current and historical procedures performed on or for a patient. A procedure is an activity that is performed on, with, or for a patient as part of the provision of care. This resource provides summary information about the occurrence of the procedure and is not intended to provide real-time snapshots of a procedure as it unfolds.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
... meta
.... lastUpdated 0..1 instant When the resource version last changed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... instantiatesCanonical 0..0
... basedOn 0..0
... partOf 0..0
... statusReason 0..0
... category 0..0
... subject 1..1 Reference(Patient) Who the procedure was performed on
... performed[x] 0..1 When the procedure was performed
.... performedDateTime dateTime
.... performedPeriod Period
... recorder 0..0
... asserter 0..0
... performer
.... function 0..0
.... actor 1..1 Reference(Practitioner) The reference to the practitioner
... location 0..0
... reasonCode 0..0
... reasonReference 0..0
... outcome 0..0
... report 0..0
... complication 0..0
... complicationDetail 0..0
... followUp 0..0
... note 0..0
... focalDevice
.... action 0..0
... usedReference 0..0
... usedCode 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... subject Σ 1..1 Reference(Patient) Who the procedure was performed on
ele-1: All FHIR elements must have a @value or children
... performed[x] Σ 0..1 When the procedure was performed
ele-1: All FHIR elements must have a @value or children
.... performedDateTime dateTime
.... performedPeriod Period

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
... id Σ 0..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
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Identifiers for this procedure
... status ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.

... code Σ 0..1 CodeableConcept Identification of the procedure
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .

... subject Σ 1..1 Reference(Patient) Who the procedure was performed on
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... performed[x] Σ 0..1 When the procedure was performed
.... performedDateTime dateTime
.... performedPeriod Period
... 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
.... actor Σ 1..1 Reference(Practitioner) The reference to the practitioner
.... onBehalfOf 0..1 Reference(Organization) Organization the device or practitioner was acting for
... bodySite Σ 0..* CodeableConcept Target body sites
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... 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
.... manipulated 1..1 Reference(Device) Device that was changed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Procedure.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Procedure.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

This structure is derived from Procedure

Summary

Mandatory: 2 elements
Prohibited: 21 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
... meta
.... lastUpdated 0..1 instant When the resource version last changed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... instantiatesCanonical 0..0
... basedOn 0..0
... partOf 0..0
... statusReason 0..0
... category 0..0
... subject 1..1 Reference(Patient) Who the procedure was performed on
... performed[x] 0..1 When the procedure was performed
.... performedDateTime dateTime
.... performedPeriod Period
... recorder 0..0
... asserter 0..0
... performer
.... function 0..0
.... actor 1..1 Reference(Practitioner) The reference to the practitioner
... location 0..0
... reasonCode 0..0
... reasonReference 0..0
... outcome 0..0
... report 0..0
... complication 0..0
... complicationDetail 0..0
... followUp 0..0
... note 0..0
... focalDevice
.... action 0..0
... usedReference 0..0
... usedCode 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... subject Σ 1..1 Reference(Patient) Who the procedure was performed on
ele-1: All FHIR elements must have a @value or children
... performed[x] Σ 0..1 When the procedure was performed
ele-1: All FHIR elements must have a @value or children
.... performedDateTime dateTime
.... performedPeriod Period

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
... id Σ 0..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
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Identifiers for this procedure
... status ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.

... code Σ 0..1 CodeableConcept Identification of the procedure
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .

... subject Σ 1..1 Reference(Patient) Who the procedure was performed on
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... performed[x] Σ 0..1 When the procedure was performed
.... performedDateTime dateTime
.... performedPeriod Period
... 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
.... actor Σ 1..1 Reference(Practitioner) The reference to the practitioner
.... onBehalfOf 0..1 Reference(Organization) Organization the device or practitioner was acting for
... bodySite Σ 0..* CodeableConcept Target body sites
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... 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
.... manipulated 1..1 Reference(Device) Device that was changed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Procedure.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Procedure.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

This structure is derived from Procedure

Summary

Mandatory: 2 elements
Prohibited: 21 elements

Extensions

This structure refers to these extensions:

 

​Other representations of profile: CSV, Excel, Schematron