Advance Healthcare Directive Interoperability (cda-adi)
0.1.0 - ci-build

Advance Healthcare Directive Interoperability (cda-adi), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cda-adi/ and changes regularly. See the Directory of published versions

## Logical Model: Medically_Assisted_Nutrition_Planned_Procedure_Part - Detailed Descriptions

Active as of 2026-05-29

Definitions for the MedicallyAssistedNutritionPlannedProcedurePart logical model.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. Procedure
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 10..1*
Is Modifier | false
Logical Container | ClinicalDocument (CDA Class)
Validation | Instance of this type are validated by templateId
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-sdtcCategory: SHOULD contain sdtcCategory (`sdtcCategory.exists()`) should-effectiveTime: SHOULD contain effectiveTime (`effectiveTime.exists()`) should-author: SHOULD contain author (`author.exists()`)
2. Procedure.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
4. Procedure.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
6. Procedure.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
8. Procedure.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
10. Procedure.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
12. Procedure.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
14. Procedure.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
16. Procedure.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
18. 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
Control | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `Procedure.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
20. Procedure.templateId:planned-proc
Slice Name | planned-proc
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
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
22. Procedure.templateId:planned-proc.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
24. Procedure.templateId:planned-proc.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
26. Procedure.templateId:planned-proc.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
28. Procedure.templateId:planned-proc.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | `2.16.840.1.113883.10.20.22.4.41`
30. Procedure.templateId:planned-proc.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | `2022-06-01`
32. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part
Slice Name | medically-assisted-nutrition-planned-procedure-part
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
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
34. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
36. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
38. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
40. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | `2.16.840.1.113883.9.275.3.4.2`
42. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | `2026-08-28`
44. Procedure.classCode
Comments | SHALL contain exactly one [1..1] @classCode="PROC" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4515-8568).
Control | 1..1
Binding | The codes SHALL be taken from ActClassProcedure (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActClassProcedure|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PROC`
46. Procedure.moodCode
Comments | SHALL contain exactly one [1..1] @moodCode="RQO" Request (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC).
Control | 1..1
Binding | The codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `RQO`
48. Procedure.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | MUST contain at least one [1..*] id. If needed, the identifier for the procedure part of this clinical statement can be the id of the statement suffixed with a part# to make it distinct. 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.
Control | 10..*1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
50. Procedure.sdtcCategory
Control | 0..*
Binding | The codes SHOULD be taken from US Core ServiceRequest Category Codes (preferred to `http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`category`.
52. 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").
Short | 𝗨𝗦𝗖𝗗𝗜: SDOH InterventionsIdentification of the procedure
Comments | This code SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet US Core Procedure Codes urn:oid:2.16.840.1.113883.4.642.40.48.31 .
Control | 10..1
Binding | The codes SHOULD be taken from For example codes, see US Core Procedure Codes http://hl7.org/fhir/ValueSet/procedure-code|5.0.0 (preferred to `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD CodeableConcept
Is Modifier | false
Requirements | 0..1 to account for primarily narrative only resources.
Alternate Names | type
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Procedure.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
56. Procedure.code.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | `386373004`
58. Procedure.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
60. Procedure.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
62. Procedure.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
64. Procedure.code.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
66. Procedure.code.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
68. Procedure.code.sdtcValueSetVersion
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
70. Procedure.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
72. Procedure.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
74. Procedure.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
76. Procedure.negationInd
Comments | If the order is to NOT perform the procedure, then negationInd will be true for the procedure. In FHIR this aligns with use of the doNotPerform element.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
78. 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.
Short | links to the rendering of the portable medical orderText 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.
Control | 10..1 This element is affected by the following invariants: should-text-ref-value, dom-6
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED Narrative
Is Modifier | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Procedure.text.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
82. Procedure.text.compression
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used.
Control | 0..1
Binding | The codes SHALL be taken from CDACompressionAlgorithm (required to `http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Compression
84. Procedure.text.integrityCheck
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.
Control | 0..1
Type | base64Binary(bin: Binary Data)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Integrity Check
86. Procedure.text.integrityCheckAlgorithm
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.
Control | 0..1
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Integrity Check Algorithm
88. Procedure.text.language
Definition | For character based information the language property specifies the human language of the text.
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Language
90. Procedure.text.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Control | 0..1
Binding | For example codes, see MediaType (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-MediaType|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Media Type
92. Procedure.text.representation
Control | 0..1
Binding | The codes SHALL be taken from CDABinaryDataEncoding (required to `http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
94. Procedure.text.xmlText
Definition | Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
Short | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as unadorned text.
96. Procedure.text.reference
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Label | Reference
Invariants | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (`value.exists() implies value.startsWith('#')`)
98. Procedure.text.thumbnail
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Thumbnail
Invariants | ED-1: Thumbnails cannot contain their own thumbnails (`thumbnail.empty()`)
100. Procedure.statusCode
Comments | SHALL contain exactly one [1..1] statusCode (CONF:4515-30446).
Control | 1..1
Binding | The codes SHALL be taken from ActStatus (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
102. Procedure.statusCode.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
104. Procedure.statusCode.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments | This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:4515-31978).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Fixed Value | `active`
106. Procedure.statusCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
108. Procedure.statusCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
110. Procedure.statusCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
112. Procedure.statusCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
114. Procedure.statusCode.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
116. Procedure.statusCode.sdtcValueSetVersion
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
118. Procedure.statusCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
120. Procedure.statusCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
122. Procedure.statusCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
124. Procedure.effectiveTime
Short | Represents the trial period duration, if a trial period is specified.
Comments | SHOULD contain zero or one [0..1] effectiveTime (CONF:4515-30447).
Control | 0..1 This element is affected by the following invariants: should-effectiveTime
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
126. Procedure.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
128. Procedure.languageCode
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
130. Procedure.methodCode
Definition | Drawn from concept domain ProcedureMethod
Short | In a planned procedure the provider may suggest that a procedure should be performed using a particular method. MethodCode *SHALL NOT* conflict with the method inherent in Procedure/code.
Comments | MAY contain zero or more [0..*] methodCode (CONF:4515-31980).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
132. Procedure.approachSiteCode
Definition | Drawn from concept domain ActSite
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
134. Procedure.targetSiteCode
Definition | Drawn from concept domain ActSite
Short | The targetSiteCode is used to identify the part of the body of concern for the planned procedure.
Comments | MAY contain zero or more [0..*] targetSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:4515-31981).
Control | 0..*
Binding | The codes SHALL be taken from Body Site Value Set (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
136. 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.
Short | Individual or entity the procedure was performed on
Control | 01..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject Reference(Patient, Group, Device, Practitioner, Organization, Location)
Is Modifier | false
Alternate Names | patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Procedure.specimen
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen
140. Procedure.performer
Definition | Indicates who or what performed the procedure and how they were involved.
Short | The clinician who is expected to perform the procedure could be identified using procedure/performer.Who performed the procedure and what they did
Comments | MAY contain zero or more [0..*] performer (CONF:4515-30449).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 BackboneElement
Is Modifier | false
Invariants | ele-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())
142. Procedure.author
Short | The author in a planned procedure represents the clinician who is requesting or planning the procedure.
Comments | SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:4515-31979).
Control | 0..1 This element is affected by the following invariants: should-author
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
144. Procedure.informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
146. Procedure.participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
148. Procedure.entryRelationship
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-32996) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing | This element introduces a set of slices on `Procedure.entryRelationship`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ act profile @ observation
150. Procedure.entryRelationship:priorityPreference
Slice Name | priorityPreference
Short | The following entryRelationship represents the priority that a patient or a provider places on the procedure.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-31079) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
152. Procedure.entryRelationship:priorityPreference.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
154. Procedure.entryRelationship:priorityPreference.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
156. Procedure.entryRelationship:priorityPreference.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
158. Procedure.entryRelationship:priorityPreference.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
160. Procedure.entryRelationship:priorityPreference.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
162. Procedure.entryRelationship:priorityPreference.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
164. Procedure.entryRelationship:priorityPreference.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
166. Procedure.entryRelationship:priorityPreference.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
168. Procedure.entryRelationship:priorityPreference.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
170. Procedure.entryRelationship:priorityPreference.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-31080).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `REFR`
172. Procedure.entryRelationship:priorityPreference.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
174. Procedure.entryRelationship:priorityPreference.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
176. Procedure.entryRelationship:priorityPreference.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
178. Procedure.entryRelationship:priorityPreference.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
180. Procedure.entryRelationship:priorityPreference.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
182. Procedure.entryRelationship:priorityPreference.act
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
184. Procedure.entryRelationship:priorityPreference.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
186. Procedure.entryRelationship:priorityPreference.observation
Comments | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:4515-31081).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
188. Procedure.entryRelationship:priorityPreference.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
190. Procedure.entryRelationship:priorityPreference.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
192. Procedure.entryRelationship:priorityPreference.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
194. Procedure.entryRelationship:priorityPreference.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
196. Procedure.entryRelationship:priorityPreference.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
198. Procedure.entryRelationship:priorityPreference.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
200. Procedure.entryRelationship:indication
Slice Name | indication
Short | The following entryRelationship represents the indication for the procedure.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-31982) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
202. Procedure.entryRelationship:indication.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
204. Procedure.entryRelationship:indication.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
206. Procedure.entryRelationship:indication.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
208. Procedure.entryRelationship:indication.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
210. Procedure.entryRelationship:indication.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
212. Procedure.entryRelationship:indication.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
214. Procedure.entryRelationship:indication.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
216. Procedure.entryRelationship:indication.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
218. Procedure.entryRelationship:indication.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
220. Procedure.entryRelationship:indication.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-31983).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `RSON`
222. Procedure.entryRelationship:indication.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
224. Procedure.entryRelationship:indication.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
226. Procedure.entryRelationship:indication.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
228. Procedure.entryRelationship:indication.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
230. Procedure.entryRelationship:indication.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
232. Procedure.entryRelationship:indication.act
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
234. Procedure.entryRelationship:indication.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
236. Procedure.entryRelationship:indication.observation
Comments | SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:4515-31984).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
238. Procedure.entryRelationship:indication.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
240. Procedure.entryRelationship:indication.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
242. Procedure.entryRelationship:indication.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
244. Procedure.entryRelationship:indication.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
246. Procedure.entryRelationship:indication.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
248. Procedure.entryRelationship:indication.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
250. Procedure.entryRelationship:instruction
Slice Name | instruction
Short | The following entryRelationship captures any instructions associated with the planned procedure.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-31985) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
252. Procedure.entryRelationship:instruction.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
254. Procedure.entryRelationship:instruction.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
256. Procedure.entryRelationship:instruction.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
258. Procedure.entryRelationship:instruction.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
260. Procedure.entryRelationship:instruction.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
262. Procedure.entryRelationship:instruction.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
264. Procedure.entryRelationship:instruction.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
266. Procedure.entryRelationship:instruction.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
268. Procedure.entryRelationship:instruction.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
270. Procedure.entryRelationship:instruction.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-31986).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `SUBJ`
272. Procedure.entryRelationship:instruction.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Comments | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:4515-31987).
Control | 1..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `true`
274. Procedure.entryRelationship:instruction.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
276. Procedure.entryRelationship:instruction.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
278. Procedure.entryRelationship:instruction.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
280. Procedure.entryRelationship:instruction.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
282. Procedure.entryRelationship:instruction.act
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
284. Procedure.entryRelationship:instruction.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
286. Procedure.entryRelationship:instruction.observation
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Instruction Observation)
288. Procedure.entryRelationship:instruction.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
290. Procedure.entryRelationship:instruction.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
292. Procedure.entryRelationship:instruction.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
294. Procedure.entryRelationship:instruction.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
296. Procedure.entryRelationship:instruction.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
298. Procedure.entryRelationship:instruction.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
300. Procedure.entryRelationship:coverage
Slice Name | coverage
Short | The following entryRelationship represents the insurance coverage the patient may have for the procedure.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-31990) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
302. Procedure.entryRelationship:coverage.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
304. Procedure.entryRelationship:coverage.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
306. Procedure.entryRelationship:coverage.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
308. Procedure.entryRelationship:coverage.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
310. Procedure.entryRelationship:coverage.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
312. Procedure.entryRelationship:coverage.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
314. Procedure.entryRelationship:coverage.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
316. Procedure.entryRelationship:coverage.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
318. Procedure.entryRelationship:coverage.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
320. Procedure.entryRelationship:coverage.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="COMP" Has component (CONF:4515-31991).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `COMP`
322. Procedure.entryRelationship:coverage.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
324. Procedure.entryRelationship:coverage.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
326. Procedure.entryRelationship:coverage.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
328. Procedure.entryRelationship:coverage.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
330. Procedure.entryRelationship:coverage.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
332. Procedure.entryRelationship:coverage.act
Comments | SHALL contain exactly one [1..1] Planned Coverage (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.129) (CONF:4515-31992).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Planned Coverage)
334. Procedure.entryRelationship:coverage.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
336. Procedure.entryRelationship:coverage.observation
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation
338. Procedure.entryRelationship:coverage.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
340. Procedure.entryRelationship:coverage.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
342. Procedure.entryRelationship:coverage.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
344. Procedure.entryRelationship:coverage.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
346. Procedure.entryRelationship:coverage.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
348. Procedure.entryRelationship:coverage.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
350. Procedure.entryRelationship:assessmentScale
Slice Name | assessmentScale
Short | When an Assessment Scale Observation is contained in a Procedure Template instance that is a Social Determinant of Health procedure, that Assessment scale **MAY** contain Assessment Scale observations that represent LOINC question and answer pairs from SDOH screening instruments.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-32994) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
352. Procedure.entryRelationship:assessmentScale.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
354. Procedure.entryRelationship:assessmentScale.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
356. Procedure.entryRelationship:assessmentScale.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
358. Procedure.entryRelationship:assessmentScale.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
360. Procedure.entryRelationship:assessmentScale.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
362. Procedure.entryRelationship:assessmentScale.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
364. Procedure.entryRelationship:assessmentScale.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
366. Procedure.entryRelationship:assessmentScale.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
368. Procedure.entryRelationship:assessmentScale.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
370. Procedure.entryRelationship:assessmentScale.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-32998).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `RSON`
372. Procedure.entryRelationship:assessmentScale.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
374. Procedure.entryRelationship:assessmentScale.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
376. Procedure.entryRelationship:assessmentScale.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
378. Procedure.entryRelationship:assessmentScale.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
380. Procedure.entryRelationship:assessmentScale.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
382. Procedure.entryRelationship:assessmentScale.act
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
384. Procedure.entryRelationship:assessmentScale.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
386. Procedure.entryRelationship:assessmentScale.observation
Comments | SHALL contain exactly one [1..1] Assessment Scale Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.69) (CONF:4515-32995).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Assessment Scale Observation)
388. Procedure.entryRelationship:assessmentScale.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
390. Procedure.entryRelationship:assessmentScale.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
392. Procedure.entryRelationship:assessmentScale.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
394. Procedure.entryRelationship:assessmentScale.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
396. Procedure.entryRelationship:assessmentScale.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
398. Procedure.entryRelationship:assessmentScale.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
400. Procedure.entryRelationship:entryReference
Slice Name | entryReference
Short | When an Entry Reference Template is contained in a Procedure Template instance that is a Social Determinant of Health procedure, that Entry Reference **MAY** refer to Assessment Scale Observation in the same document that represent LOINC question and answer pairs from SDOH screening instruments.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
402. Procedure.entryRelationship:entryReference.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
404. Procedure.entryRelationship:entryReference.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
406. Procedure.entryRelationship:entryReference.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
408. Procedure.entryRelationship:entryReference.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
410. Procedure.entryRelationship:entryReference.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
412. Procedure.entryRelationship:entryReference.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
414. Procedure.entryRelationship:entryReference.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
416. Procedure.entryRelationship:entryReference.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
418. Procedure.entryRelationship:entryReference.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
420. Procedure.entryRelationship:entryReference.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CONF:4515-32999).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `RSON`
422. Procedure.entryRelationship:entryReference.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
424. Procedure.entryRelationship:entryReference.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
426. Procedure.entryRelationship:entryReference.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
428. Procedure.entryRelationship:entryReference.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
430. Procedure.entryRelationship:entryReference.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
432. Procedure.entryRelationship:entryReference.act
Comments | SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:4515-32997).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
434. Procedure.entryRelationship:entryReference.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
436. Procedure.entryRelationship:entryReference.observation
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation
438. Procedure.entryRelationship:entryReference.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
440. Procedure.entryRelationship:entryReference.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
442. Procedure.entryRelationship:entryReference.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
444. Procedure.entryRelationship:entryReference.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
446. Procedure.entryRelationship:entryReference.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
448. Procedure.entryRelationship:entryReference.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
450. Procedure.reference
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference
452. Procedure.precondition
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition
454. Procedure.sdtcPrecondition2
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`precondition2`.
456. Procedure.sdtcInFulfillmentOf1
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`inFulfillmentOf1`.

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

0. Procedure
Logical Container | ClinicalDocument (CDA Class)
Validation | Instance of this type are validated by templateId
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Procedure.templateId
Control | 2..?
4. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part
Slice Name | medically-assisted-nutrition-planned-procedure-part
Control | 1..1
6. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.root
Control | 1..?
Pattern Value | `2.16.840.1.113883.9.275.3.4.2`
8. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.extension
Control | 1..?
Pattern Value | `2026-08-28`
10. Procedure.moodCode
Comments | SHALL contain exactly one [1..1] @moodCode="RQO" Request (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC).
Fixed Value | `RQO`
12. Procedure.id
Comments | MUST contain at least one [1..*] id. If needed, the identifier for the procedure part of this clinical statement can be the id of the statement suffixed with a part# to make it distinct.
14. Procedure.code
16. Procedure.code.code
Pattern Value | `386373004`
18. Procedure.negationInd
Comments | If the order is to NOT perform the procedure, then negationInd will be true for the procedure. In FHIR this aligns with use of the doNotPerform element.
Must Support | true
20. Procedure.text
Short | links to the rendering of the portable medical order
Control | 1..?
22. Procedure.effectiveTime
Short | Represents the trial period duration, if a trial period is specified.

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

0. Procedure
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short | Base for all types and resources
Control | 1..1
Is Modifier | false
Logical Container | ClinicalDocument (CDA Class)
Validation | Instance of this type are validated by templateId
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-sdtcCategory: SHOULD contain sdtcCategory (`sdtcCategory.exists()`) should-effectiveTime: SHOULD contain effectiveTime (`effectiveTime.exists()`) should-author: SHOULD contain author (`author.exists()`)
2. Procedure.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
4. Procedure.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
6. Procedure.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
8. Procedure.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
10. Procedure.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
12. Procedure.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
14. Procedure.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
16. Procedure.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
18. 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
Control | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `Procedure.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
20. Procedure.templateId:planned-proc
Slice Name | planned-proc
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
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
22. Procedure.templateId:planned-proc.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
24. Procedure.templateId:planned-proc.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
26. Procedure.templateId:planned-proc.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
28. Procedure.templateId:planned-proc.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | `2.16.840.1.113883.10.20.22.4.41`
30. Procedure.templateId:planned-proc.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | `2022-06-01`
32. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part
Slice Name | medically-assisted-nutrition-planned-procedure-part
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
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
34. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
36. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
38. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
40. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | `2.16.840.1.113883.9.275.3.4.2`
42. Procedure.templateId:medically-assisted-nutrition-planned-procedure-part.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | `2026-08-28`
44. Procedure.classCode
Comments | SHALL contain exactly one [1..1] @classCode="PROC" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4515-8568).
Control | 1..1
Binding | The codes SHALL be taken from ActClassProcedure (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActClassProcedure|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PROC`
46. Procedure.moodCode
Comments | SHALL contain exactly one [1..1] @moodCode="RQO" Request (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC).
Control | 1..1
Binding | The codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `RQO`
48. Procedure.id
Comments | MUST contain at least one [1..*] id. If needed, the identifier for the procedure part of this clinical statement can be the id of the statement suffixed with a part# to make it distinct.
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
50. Procedure.sdtcCategory
Control | 0..*
Binding | The codes SHOULD be taken from US Core ServiceRequest Category Codes (preferred to `http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`category`.
52. Procedure.code
Definition | Drawn from concept domain ActCode
Short | 𝗨𝗦𝗖𝗗𝗜: SDOH Interventions
Comments | This code SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet US Core Procedure Codes urn:oid:2.16.840.1.113883.4.642.40.48.31 .
Control | 1..1
Binding | The codes SHOULD be taken from US Core Procedure Codes (preferred to `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
54. Procedure.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
56. Procedure.code.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | `386373004`
58. Procedure.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
60. Procedure.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
62. Procedure.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
64. Procedure.code.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
66. Procedure.code.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
68. Procedure.code.sdtcValueSetVersion
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
70. Procedure.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
72. Procedure.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
74. Procedure.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
76. Procedure.negationInd
Comments | If the order is to NOT perform the procedure, then negationInd will be true for the procedure. In FHIR this aligns with use of the doNotPerform element.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
78. Procedure.text
Short | links to the rendering of the portable medical order
Control | 1..1 This element is affected by the following invariants: should-text-ref-value
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
80. Procedure.text.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
82. Procedure.text.compression
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used.
Control | 0..1
Binding | The codes SHALL be taken from CDACompressionAlgorithm (required to `http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Compression
84. Procedure.text.integrityCheck
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.
Control | 0..1
Type | base64Binary(bin: Binary Data)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Integrity Check
86. Procedure.text.integrityCheckAlgorithm
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.
Control | 0..1
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Integrity Check Algorithm
88. Procedure.text.language
Definition | For character based information the language property specifies the human language of the text.
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Language
90. Procedure.text.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Control | 0..1
Binding | For example codes, see MediaType (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-MediaType|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Media Type
92. Procedure.text.representation
Control | 0..1
Binding | The codes SHALL be taken from CDABinaryDataEncoding (required to `http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
94. Procedure.text.xmlText
Definition | Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
Short | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as unadorned text.
96. Procedure.text.reference
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Label | Reference
Invariants | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (`value.exists() implies value.startsWith('#')`)
98. Procedure.text.thumbnail
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Thumbnail
Invariants | ED-1: Thumbnails cannot contain their own thumbnails (`thumbnail.empty()`)
100. Procedure.statusCode
Comments | SHALL contain exactly one [1..1] statusCode (CONF:4515-30446).
Control | 1..1
Binding | The codes SHALL be taken from ActStatus (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
102. Procedure.statusCode.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
104. Procedure.statusCode.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments | This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:4515-31978).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Fixed Value | `active`
106. Procedure.statusCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
108. Procedure.statusCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
110. Procedure.statusCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
112. Procedure.statusCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
114. Procedure.statusCode.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
116. Procedure.statusCode.sdtcValueSetVersion
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
118. Procedure.statusCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
120. Procedure.statusCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
122. Procedure.statusCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
124. Procedure.effectiveTime
Short | Represents the trial period duration, if a trial period is specified.
Comments | SHOULD contain zero or one [0..1] effectiveTime (CONF:4515-30447).
Control | 0..1 This element is affected by the following invariants: should-effectiveTime
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
126. Procedure.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
128. Procedure.languageCode
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
130. Procedure.methodCode
Definition | Drawn from concept domain ProcedureMethod
Short | In a planned procedure the provider may suggest that a procedure should be performed using a particular method. MethodCode *SHALL NOT* conflict with the method inherent in Procedure/code.
Comments | MAY contain zero or more [0..*] methodCode (CONF:4515-31980).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
132. Procedure.approachSiteCode
Definition | Drawn from concept domain ActSite
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
134. Procedure.targetSiteCode
Definition | Drawn from concept domain ActSite
Short | The targetSiteCode is used to identify the part of the body of concern for the planned procedure.
Comments | MAY contain zero or more [0..*] targetSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:4515-31981).
Control | 0..*
Binding | The codes SHALL be taken from Body Site Value Set (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
136. Procedure.subject
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject
138. Procedure.specimen
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen
140. Procedure.performer
Short | The clinician who is expected to perform the procedure could be identified using procedure/performer.
Comments | MAY contain zero or more [0..*] performer (CONF:4515-30449).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
142. Procedure.author
Short | The author in a planned procedure represents the clinician who is requesting or planning the procedure.
Comments | SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:4515-31979).
Control | 0..1 This element is affected by the following invariants: should-author
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
144. Procedure.informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
146. Procedure.participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
148. Procedure.entryRelationship
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-32996) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing | This element introduces a set of slices on `Procedure.entryRelationship`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ act profile @ observation
150. Procedure.entryRelationship:priorityPreference
Slice Name | priorityPreference
Short | The following entryRelationship represents the priority that a patient or a provider places on the procedure.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-31079) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
152. Procedure.entryRelationship:priorityPreference.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
154. Procedure.entryRelationship:priorityPreference.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
156. Procedure.entryRelationship:priorityPreference.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
158. Procedure.entryRelationship:priorityPreference.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
160. Procedure.entryRelationship:priorityPreference.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
162. Procedure.entryRelationship:priorityPreference.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
164. Procedure.entryRelationship:priorityPreference.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
166. Procedure.entryRelationship:priorityPreference.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
168. Procedure.entryRelationship:priorityPreference.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
170. Procedure.entryRelationship:priorityPreference.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-31080).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `REFR`
172. Procedure.entryRelationship:priorityPreference.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
174. Procedure.entryRelationship:priorityPreference.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
176. Procedure.entryRelationship:priorityPreference.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
178. Procedure.entryRelationship:priorityPreference.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
180. Procedure.entryRelationship:priorityPreference.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
182. Procedure.entryRelationship:priorityPreference.act
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
184. Procedure.entryRelationship:priorityPreference.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
186. Procedure.entryRelationship:priorityPreference.observation
Comments | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:4515-31081).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
188. Procedure.entryRelationship:priorityPreference.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
190. Procedure.entryRelationship:priorityPreference.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
192. Procedure.entryRelationship:priorityPreference.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
194. Procedure.entryRelationship:priorityPreference.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
196. Procedure.entryRelationship:priorityPreference.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
198. Procedure.entryRelationship:priorityPreference.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
200. Procedure.entryRelationship:indication
Slice Name | indication
Short | The following entryRelationship represents the indication for the procedure.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-31982) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
202. Procedure.entryRelationship:indication.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
204. Procedure.entryRelationship:indication.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
206. Procedure.entryRelationship:indication.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
208. Procedure.entryRelationship:indication.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
210. Procedure.entryRelationship:indication.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
212. Procedure.entryRelationship:indication.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
214. Procedure.entryRelationship:indication.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
216. Procedure.entryRelationship:indication.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
218. Procedure.entryRelationship:indication.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
220. Procedure.entryRelationship:indication.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-31983).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `RSON`
222. Procedure.entryRelationship:indication.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
224. Procedure.entryRelationship:indication.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
226. Procedure.entryRelationship:indication.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
228. Procedure.entryRelationship:indication.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
230. Procedure.entryRelationship:indication.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
232. Procedure.entryRelationship:indication.act
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
234. Procedure.entryRelationship:indication.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
236. Procedure.entryRelationship:indication.observation
Comments | SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:4515-31984).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
238. Procedure.entryRelationship:indication.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
240. Procedure.entryRelationship:indication.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
242. Procedure.entryRelationship:indication.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
244. Procedure.entryRelationship:indication.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
246. Procedure.entryRelationship:indication.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
248. Procedure.entryRelationship:indication.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
250. Procedure.entryRelationship:instruction
Slice Name | instruction
Short | The following entryRelationship captures any instructions associated with the planned procedure.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-31985) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
252. Procedure.entryRelationship:instruction.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
254. Procedure.entryRelationship:instruction.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
256. Procedure.entryRelationship:instruction.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
258. Procedure.entryRelationship:instruction.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
260. Procedure.entryRelationship:instruction.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
262. Procedure.entryRelationship:instruction.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
264. Procedure.entryRelationship:instruction.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
266. Procedure.entryRelationship:instruction.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
268. Procedure.entryRelationship:instruction.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
270. Procedure.entryRelationship:instruction.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-31986).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `SUBJ`
272. Procedure.entryRelationship:instruction.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Comments | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:4515-31987).
Control | 1..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `true`
274. Procedure.entryRelationship:instruction.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
276. Procedure.entryRelationship:instruction.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
278. Procedure.entryRelationship:instruction.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
280. Procedure.entryRelationship:instruction.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
282. Procedure.entryRelationship:instruction.act
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
284. Procedure.entryRelationship:instruction.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
286. Procedure.entryRelationship:instruction.observation
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Instruction Observation)
288. Procedure.entryRelationship:instruction.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
290. Procedure.entryRelationship:instruction.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
292. Procedure.entryRelationship:instruction.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
294. Procedure.entryRelationship:instruction.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
296. Procedure.entryRelationship:instruction.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
298. Procedure.entryRelationship:instruction.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
300. Procedure.entryRelationship:coverage
Slice Name | coverage
Short | The following entryRelationship represents the insurance coverage the patient may have for the procedure.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-31990) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
302. Procedure.entryRelationship:coverage.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
304. Procedure.entryRelationship:coverage.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
306. Procedure.entryRelationship:coverage.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
308. Procedure.entryRelationship:coverage.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
310. Procedure.entryRelationship:coverage.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
312. Procedure.entryRelationship:coverage.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
314. Procedure.entryRelationship:coverage.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
316. Procedure.entryRelationship:coverage.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
318. Procedure.entryRelationship:coverage.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
320. Procedure.entryRelationship:coverage.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="COMP" Has component (CONF:4515-31991).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `COMP`
322. Procedure.entryRelationship:coverage.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
324. Procedure.entryRelationship:coverage.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
326. Procedure.entryRelationship:coverage.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
328. Procedure.entryRelationship:coverage.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
330. Procedure.entryRelationship:coverage.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
332. Procedure.entryRelationship:coverage.act
Comments | SHALL contain exactly one [1..1] Planned Coverage (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.129) (CONF:4515-31992).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Planned Coverage)
334. Procedure.entryRelationship:coverage.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
336. Procedure.entryRelationship:coverage.observation
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation
338. Procedure.entryRelationship:coverage.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
340. Procedure.entryRelationship:coverage.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
342. Procedure.entryRelationship:coverage.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
344. Procedure.entryRelationship:coverage.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
346. Procedure.entryRelationship:coverage.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
348. Procedure.entryRelationship:coverage.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
350. Procedure.entryRelationship:assessmentScale
Slice Name | assessmentScale
Short | When an Assessment Scale Observation is contained in a Procedure Template instance that is a Social Determinant of Health procedure, that Assessment scale **MAY** contain Assessment Scale observations that represent LOINC question and answer pairs from SDOH screening instruments.
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-32994) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
352. Procedure.entryRelationship:assessmentScale.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
354. Procedure.entryRelationship:assessmentScale.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
356. Procedure.entryRelationship:assessmentScale.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
358. Procedure.entryRelationship:assessmentScale.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
360. Procedure.entryRelationship:assessmentScale.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
362. Procedure.entryRelationship:assessmentScale.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
364. Procedure.entryRelationship:assessmentScale.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
366. Procedure.entryRelationship:assessmentScale.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
368. Procedure.entryRelationship:assessmentScale.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
370. Procedure.entryRelationship:assessmentScale.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-32998).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `RSON`
372. Procedure.entryRelationship:assessmentScale.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
374. Procedure.entryRelationship:assessmentScale.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
376. Procedure.entryRelationship:assessmentScale.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
378. Procedure.entryRelationship:assessmentScale.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
380. Procedure.entryRelationship:assessmentScale.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
382. Procedure.entryRelationship:assessmentScale.act
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
384. Procedure.entryRelationship:assessmentScale.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
386. Procedure.entryRelationship:assessmentScale.observation
Comments | SHALL contain exactly one [1..1] Assessment Scale Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.69) (CONF:4515-32995).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Assessment Scale Observation)
388. Procedure.entryRelationship:assessmentScale.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
390. Procedure.entryRelationship:assessmentScale.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
392. Procedure.entryRelationship:assessmentScale.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
394. Procedure.entryRelationship:assessmentScale.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
396. Procedure.entryRelationship:assessmentScale.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
398. Procedure.entryRelationship:assessmentScale.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
400. Procedure.entryRelationship:entryReference
Slice Name | entryReference
Short | When an Entry Reference Template is contained in a Procedure Template instance that is a Social Determinant of Health procedure, that Entry Reference **MAY** refer to Assessment Scale Observation in the same document that represent LOINC question and answer pairs from SDOH screening instruments.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
402. Procedure.entryRelationship:entryReference.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
404. Procedure.entryRelationship:entryReference.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
406. Procedure.entryRelationship:entryReference.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
408. Procedure.entryRelationship:entryReference.typeId.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
410. Procedure.entryRelationship:entryReference.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
412. Procedure.entryRelationship:entryReference.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
414. Procedure.entryRelationship:entryReference.typeId.root
Definition | Identifies the type as an HL7 Registered model
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Fixed Value | `2.16.840.1.113883.1.3`
416. Procedure.entryRelationship:entryReference.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
418. Procedure.entryRelationship:entryReference.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
420. Procedure.entryRelationship:entryReference.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CONF:4515-32999).
Control | 1..1
Binding | The codes SHALL be taken from XActRelationshipEntryRelationship (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship|3.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `RSON`
422. Procedure.entryRelationship:entryReference.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
424. Procedure.entryRelationship:entryReference.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | `true`
426. Procedure.entryRelationship:entryReference.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
428. Procedure.entryRelationship:entryReference.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
430. Procedure.entryRelationship:entryReference.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
432. Procedure.entryRelationship:entryReference.act
Comments | SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:4515-32997).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
434. Procedure.entryRelationship:entryReference.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
436. Procedure.entryRelationship:entryReference.observation
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation
438. Procedure.entryRelationship:entryReference.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
440. Procedure.entryRelationship:entryReference.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
442. Procedure.entryRelationship:entryReference.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
444. Procedure.entryRelationship:entryReference.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
446. Procedure.entryRelationship:entryReference.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
448. Procedure.entryRelationship:entryReference.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
450. Procedure.reference
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference
452. Procedure.precondition
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition
454. Procedure.sdtcPrecondition2
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`precondition2`.
456. Procedure.sdtcInFulfillmentOf1
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`inFulfillmentOf1`.