Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CDAR2.Procedure - Detailed Descriptions

Active as of 2023-10-03

Definitions for the Procedure logical model.

Guidance on how to interpret the contents of this table can be found here

0. Procedure
Control1..1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Procedure.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassProcedure
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default ValuePROC
Fixed ValuePROC
4. Procedure.moodCode
Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
6. Procedure.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
8. Procedure.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Procedure.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Procedure.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
14. Procedure.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
16. Procedure.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
18. Procedure.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
20. Procedure.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
22. Procedure.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
24. Procedure.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
26. Procedure.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
28. Procedure.methodCode
Definition

Drawn from concept domain ProcedureMethod

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
30. Procedure.approachSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
32. Procedure.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
34. Procedure.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
36. Procedure.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
38. Procedure.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
40. Procedure.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
42. Procedure.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
44. Procedure.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
46. Procedure.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
48. Procedure.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
50. Procedure.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition

Guidance on how to interpret the contents of this table can be found here

0. Procedure
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Procedure.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassProcedure
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default ValuePROC
Fixed ValuePROC
4. Procedure.moodCode
Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
6. Procedure.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
8. Procedure.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Procedure.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Procedure.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..*1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifierfalse
14. Procedure.code
Definition

Drawn from concept domain ActCode


The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").

ShortIdentification of the procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept
Is Modifierfalse
Requirements

0..1 to account for primarily narrative only resources.

Alternate Namestype
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Procedure.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
18. Procedure.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EDNarrative
Is Modifierfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Procedure.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
22. Procedure.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
24. Procedure.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
26. Procedure.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
28. Procedure.methodCode
Definition

Drawn from concept domain ProcedureMethod

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
30. Procedure.approachSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
32. Procedure.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
34. Procedure.subject
Definition

On whom or on what the procedure was performed. This is usually an individual human, but can also be performed on animals, groups of humans or animals, organizations or practitioners (for licensing), locations or devices (for safety inspections or regulatory authorizations). If the actual focus of the procedure is different from the subject, the focus element specifies the actual focus of the procedure.

ShortIndividual or entity the procedure was performed on
Control01..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubjectReference(Patient, Group, Device, Practitioner, Organization, Location)
Is Modifierfalse
Alternate Namespatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Procedure.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
38. Procedure.performer
Definition

Indicates who or what performed the procedure and how they were involved.

ShortWho performed the procedure and what they did
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2BackboneElement
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
prc-1: Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole (onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty())
40. Procedure.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
42. Procedure.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
44. Procedure.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
46. Procedure.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
48. Procedure.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
50. Procedure.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition

Guidance on how to interpret the contents of this table can be found here

0. Procedure
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Procedure.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassProcedure
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default ValuePROC
Fixed ValuePROC
4. Procedure.moodCode
Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
6. Procedure.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
8. Procedure.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Procedure.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Procedure.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
14. Procedure.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
16. Procedure.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
18. Procedure.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
20. Procedure.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
22. Procedure.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
24. Procedure.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
26. Procedure.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
28. Procedure.methodCode
Definition

Drawn from concept domain ProcedureMethod

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
30. Procedure.approachSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
32. Procedure.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
34. Procedure.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
36. Procedure.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
38. Procedure.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
40. Procedure.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
42. Procedure.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
44. Procedure.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
46. Procedure.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
48. Procedure.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
50. Procedure.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition