Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

## Logical Model: MedicationFreeTextSig - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the MedicationFreeTextSig logical model.

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

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

0. SubstanceAdministration
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. SubstanceAdministration.classCode
Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-32770).
4. SubstanceAdministration.moodCode
Short | moodCode must match the parent substanceAdministration EVN or INT
Comments | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:81-32771).
Binding | The codes SHALL be taken from MoodCodeEvnInt
6. SubstanceAdministration.templateId
Control | 1..?
Slicing | This element introduces a set of slices on `SubstanceAdministration.templateId`. The slices are unordered and Closed, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root
8. SubstanceAdministration.templateId:primary
Slice Name | primary
Comments | SHALL contain exactly one [1..1] templateId (CONF:81-32753) such that it, SHALL not contain [0..0] extension.
Control | 1..1
10. SubstanceAdministration.templateId:primary.root
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.147" (CONF:81-32772).
Control | 1..?
Pattern Value | 2.16.840.1.113883.10.20.22.4.147
12. SubstanceAdministration.templateId:primary.extension
Control | 0..0
14. SubstanceAdministration.code
Comments | SHALL contain exactly one [1..1] code (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-32775).
Control | 1..?
16. SubstanceAdministration.code.code
Comments | This code SHALL contain exactly one [1..1] @code="76662-6" Instructions Medication (CONF:81-32780).
Control | 1..?
Pattern Value | 76662-6
18. SubstanceAdministration.code.codeSystem
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1 STATIC) (CONF:81-32781).
Control | 1..?
Pattern Value | 2.16.840.1.113883.6.1
20. SubstanceAdministration.text
Comments | SHALL contain exactly one [1..1] text (CONF:81-32754).
Control | 1..?
22. SubstanceAdministration.text.reference
Short | Reference into the section/text to a tag that only contains free text sig.
Comments | This text SHALL contain exactly one [1..1] reference (CONF:81-32755).
Control | 1..?
24. SubstanceAdministration.text.reference.value
Comments | This reference SHOULD contain zero or one [0..1] @value (CONF:81-32756).
Invariants | 81-32774: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-32774). ()
26. SubstanceAdministration.consumable
Comments | SHALL contain exactly one [1..1] consumable (CONF:81-32776).
28. SubstanceAdministration.consumable.manufacturedProduct
Comments | This consumable SHALL contain exactly one [1..1] manufacturedProduct (CONF:81-32777).
30. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug
Comments | This manufacturedProduct SHALL contain exactly one [1..1] manufacturedLabeledDrug (CONF:81-32778).
Control | 1..?
32. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.nullFlavor
Comments | This manufacturedLabeledDrug SHALL contain exactly one [1..1] @nullFlavor="NA" Not Applicable (CONF:81-32779).
Control | 1..?
Fixed Value | NA

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

0. SubstanceAdministration
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 10..1*
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. SubstanceAdministration.classCode
Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-32770).
Control | 1..1
Binding | The codes SHALL be taken from ActClass
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.
Default Value | SBADM
Fixed Value | SBADM
4. SubstanceAdministration.moodCode
Short | moodCode must match the parent substanceAdministration EVN or INT
Comments | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:81-32771).
Control | 1..1
Binding | The codes SHALL be taken from MoodCodeEvnInt
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.
6. SubstanceAdministration.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 | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `SubstanceAdministration.templateId`. The slices are unordered and Closed, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root
8. SubstanceAdministration.templateId:primary
Slice Name | primary
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
Comments | SHALL contain exactly one [1..1] templateId (CONF:81-32753) such that it, SHALL not contain [0..0] extension.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
10. SubstanceAdministration.templateId:primary.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.147" (CONF:81-32772).
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.147
12. SubstanceAdministration.templateId:primary.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | Extension
14. SubstanceAdministration.code
Comments | SHALL contain exactly one [1..1] code (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-32775).
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ActSubstanceAdministrationCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
16. SubstanceAdministration.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.
Comments | This code SHALL contain exactly one [1..1] @code="76662-6" Instructions Medication (CONF:81-32780).
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
Pattern Value | 76662-6
18. SubstanceAdministration.code.codeSystem
Definition | Specifies the code system that defines the code.
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1 STATIC) (CONF:81-32781).
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 | Code System
Pattern Value | 2.16.840.1.113883.6.1
20. SubstanceAdministration.text
Comments | SHALL contain exactly one [1..1] text (CONF:81-32754).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
22. SubstanceAdministration.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.
Short | Reference into the section/text to a tag that only contains free text sig.
Comments | This text SHALL contain exactly one [1..1] reference (CONF:81-32755).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Label | Reference
24. SubstanceAdministration.text.reference.value
Comments | This reference SHOULD contain zero or one [0..1] @value (CONF:81-32756).
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
Invariants | 81-32774: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-32774). ()
26. SubstanceAdministration.consumable
Definition | The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.
Comments | SHALL contain exactly one [1..1] consumable (CONF:81-32776).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. SubstanceAdministration.consumable.manufacturedProduct
Comments | This consumable SHALL contain exactly one [1..1] manufacturedProduct (CONF:81-32777).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
30. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug
Comments | This manufacturedProduct SHALL contain exactly one [1..1] manufacturedLabeledDrug (CONF:81-32778).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug
32. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.nullFlavor
Comments | This manufacturedLabeledDrug SHALL contain exactly one [1..1] @nullFlavor="NA" Not Applicable (CONF:81-32779).
Control | 1..1
Binding | The codes SHALL be taken from NullFlavor
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 | NA

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

0. SubstanceAdministration
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 1..1
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. SubstanceAdministration.classCode
Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-32770).
Control | 1..1
Binding | The codes SHALL be taken from ActClass
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.
Default Value | SBADM
Fixed Value | SBADM
4. SubstanceAdministration.moodCode
Short | moodCode must match the parent substanceAdministration EVN or INT
Comments | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:81-32771).
Control | 1..1
Binding | The codes SHALL be taken from MoodCodeEvnInt
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.
6. SubstanceAdministration.realmCode
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
8. SubstanceAdministration.typeId
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
10. SubstanceAdministration.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 | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `SubstanceAdministration.templateId`. The slices are unordered and Closed, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root
12. SubstanceAdministration.templateId:primary
Slice Name | primary
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
Comments | SHALL contain exactly one [1..1] templateId (CONF:81-32753) such that it, SHALL not contain [0..0] extension.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
14. SubstanceAdministration.templateId:primary.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 NullFlavor
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
16. SubstanceAdministration.templateId:primary.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
18. SubstanceAdministration.templateId:primary.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
20. SubstanceAdministration.templateId:primary.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.147" (CONF:81-32772).
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.147
22. SubstanceAdministration.templateId:primary.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | Extension
24. SubstanceAdministration.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
26. SubstanceAdministration.code
Comments | SHALL contain exactly one [1..1] code (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-32775).
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ActSubstanceAdministrationCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
28. SubstanceAdministration.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 NullFlavor
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
30. SubstanceAdministration.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.
Comments | This code SHALL contain exactly one [1..1] @code="76662-6" Instructions Medication (CONF:81-32780).
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
Pattern Value | 76662-6
32. SubstanceAdministration.code.codeSystem
Definition | Specifies the code system that defines the code.
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1 STATIC) (CONF:81-32781).
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 | Code System
Pattern Value | 2.16.840.1.113883.6.1
34. SubstanceAdministration.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
36. SubstanceAdministration.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
38. SubstanceAdministration.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
40. SubstanceAdministration.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`.
42. SubstanceAdministration.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`.
44. SubstanceAdministration.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
46. SubstanceAdministration.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
48. SubstanceAdministration.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
50. SubstanceAdministration.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.
52. SubstanceAdministration.text
Comments | SHALL contain exactly one [1..1] text (CONF:81-32754).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
54. SubstanceAdministration.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 NullFlavor
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. SubstanceAdministration.text.charset
Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].
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 | Charset
58. SubstanceAdministration.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 CompressionAlgorithm
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
60. SubstanceAdministration.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
62. SubstanceAdministration.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
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
64. SubstanceAdministration.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
66. SubstanceAdministration.text.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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 | Media Type
68. SubstanceAdministration.text.representation
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.
70. SubstanceAdministration.text.data[x]
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.)
Control | 0..1
Type | Choice of: string(st: Character String), base64Binary(bin: Binary Data)
[x] Note | See Choice of Data Types for further information about how to use [x]
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.
72. SubstanceAdministration.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.
Short | Reference into the section/text to a tag that only contains free text sig.
Comments | This text SHALL contain exactly one [1..1] reference (CONF:81-32755).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Label | Reference
74. SubstanceAdministration.text.reference.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 NullFlavor
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
76. SubstanceAdministration.text.reference.value
Comments | This reference SHOULD contain zero or one [0..1] @value (CONF:81-32756).
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
Invariants | 81-32774: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-32774). ()
78. SubstanceAdministration.text.reference.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
80. SubstanceAdministration.text.reference.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control | 0..*
Binding | The codes SHALL be taken from AddressUse
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 | Use Code
82. SubstanceAdministration.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
84. SubstanceAdministration.statusCode
Control | 0..1
Binding | The codes SHALL be taken from ActStatus
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
86. SubstanceAdministration.effectiveTime
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
88. SubstanceAdministration.priorityCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActPriority
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
90. SubstanceAdministration.repeatNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
92. SubstanceAdministration.routeCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from RouteOfAdministration
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
94. SubstanceAdministration.approachSiteCode
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from v3 Value Set ActSite
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
96. SubstanceAdministration.doseQuantity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
98. SubstanceAdministration.rateQuantity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
100. SubstanceAdministration.maxDoseQuantity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
102. SubstanceAdministration.administrationUnitCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from AdministrableDrugForm
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
104. SubstanceAdministration.consumable
Definition | The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.
Comments | SHALL contain exactly one [1..1] consumable (CONF:81-32776).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. SubstanceAdministration.consumable.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 NullFlavor
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
108. SubstanceAdministration.consumable.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
110. SubstanceAdministration.consumable.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
112. SubstanceAdministration.consumable.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
114. SubstanceAdministration.consumable.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationTargetDirect
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 | CSM
116. SubstanceAdministration.consumable.manufacturedProduct
Comments | This consumable SHALL contain exactly one [1..1] manufacturedProduct (CONF:81-32777).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct
118. SubstanceAdministration.consumable.manufacturedProduct.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassManufacturedProduct
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 | MANU
120. SubstanceAdministration.consumable.manufacturedProduct.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
122. SubstanceAdministration.consumable.manufacturedProduct.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
124. SubstanceAdministration.consumable.manufacturedProduct.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
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`identifiedBy`.
126. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug
Comments | This manufacturedProduct SHALL contain exactly one [1..1] manufacturedLabeledDrug (CONF:81-32778).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug
128. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.nullFlavor
Comments | This manufacturedLabeledDrug SHALL contain exactly one [1..1] @nullFlavor="NA" Not Applicable (CONF:81-32779).
Control | 1..1
Binding | The codes SHALL be taken from NullFlavor
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 | NA
130. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassManufacturedMaterial
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 | MMAT
132. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminerDetermined
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 | KIND
134. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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
136. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Drug Entity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
138. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
140. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Material
142. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
144. SubstanceAdministration.subject
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject
146. SubstanceAdministration.specimen
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen
148. SubstanceAdministration.performer
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
150. SubstanceAdministration.author
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
152. SubstanceAdministration.informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
154. SubstanceAdministration.participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
156. SubstanceAdministration.entryRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
158. SubstanceAdministration.reference
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference
160. SubstanceAdministration.precondition
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition