Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA)
3.0.0 - STU3
This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Draft as of 2024-05-18 |
Definitions for the PlannedMedicationActivity logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. SubstanceAdministration | |
| 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())dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. ( doseQuantity.unit.exists() implies administrationUnitCode.empty())should-author: SHOULD contain author ( author.exists()) |
| 2. SubstanceAdministration.templateId | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on SubstanceAdministration.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. SubstanceAdministration.templateId:planned-med-activity | |
| Slice Name | planned-med-activity |
| Control | 1..1 |
| 6. SubstanceAdministration.templateId:planned-med-activity.root | |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.42 |
| 8. SubstanceAdministration.templateId:planned-med-activity.extension | |
| Control | 1..? |
| Pattern Value | 2014-06-09 |
| 10. SubstanceAdministration.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572). |
| 12. SubstanceAdministration.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573). |
| Binding | The codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply)  (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24) |
| 14. SubstanceAdministration.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1098-8575). |
| Control | 1..? |
| 16. SubstanceAdministration.text | |
| Short | SHOULD reference the portion of section narrative text corresponding to this entry |
| 18. SubstanceAdministration.text.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('#')) |
| 20. SubstanceAdministration.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1098-32087). |
| Control | 1..? |
| 22. SubstanceAdministration.statusCode.code | |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32088). |
| Control | 1..? |
| Fixed Value | active |
| 24. SubstanceAdministration.effectiveTime | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on SubstanceAdministration.effectiveTime. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. SubstanceAdministration.effectiveTime:duration | |
| Slice Name | duration |
| Short | The effectiveTime in a planned medication activity represents the time that the medication activity should occur. |
| Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:1098-30468) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| Invariants | 1098-32890: This effectiveTime **SHALL** contain either a low or a @value but not both (CONF:1098-32890). ((value.exists() or low.exists()) and ((value.exists() and low.exists()).not()))should-value-att: SHOULD contain @value ( value.exists())should-low: SHOULD contain low ( low.exists()) |
| 28. SubstanceAdministration.effectiveTime:duration.value | |
| Short | indicates a single-administration timestamp |
| Comments | SHOULD contain zero or one [0..1] @value (CONF:1098-32775). |
| 30. SubstanceAdministration.effectiveTime:duration.low | |
| Short | indicates when medication started |
| Comments | SHOULD contain zero or one [0..1] low (CONF:1098-32776). |
| 32. SubstanceAdministration.effectiveTime:duration.high | |
| Short | indicates when medication stopped |
| Comments | MAY contain zero or one [0..1] high (CONF:1098-32777). |
| 34. SubstanceAdministration.effectiveTime:periodicFrequency | |
| Slice Name | periodicFrequency |
| Short | This effectiveTime represents a periodic medication frequency (e.g., administration times per day). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS |
| 36. SubstanceAdministration.effectiveTime:periodicFrequency.operator | |
| Comments | SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106). |
| Control | 1..? |
| Pattern Value | A |
| 38. SubstanceAdministration.effectiveTime:eventFrequency | |
| Slice Name | eventFrequency |
| Short | This effectiveTime represents an event-based medication frequency (e.g., administration at bedtime). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS |
| 40. SubstanceAdministration.effectiveTime:eventFrequency.operator | |
| Comments | SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106). |
| Control | 1..? |
| Pattern Value | A |
| 42. SubstanceAdministration.repeatNumber | |
| Short | In a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. |
| Comments | MAY contain zero or one [0..1] repeatNumber (CONF:1098-32066). |
| 44. SubstanceAdministration.routeCode | |
| Comments | MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067). |
| Binding | The codes SHALL be taken from SPL Drug Route of Administration Terminology (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7) |
| Invariants | should-translation: SHOULD contain translation (translation.exists()) |
| 46. SubstanceAdministration.routeCode.translation | |
| Comments | The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952). |
| Binding | The codes SHOULD be taken from Medication Route (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12) |
| 48. SubstanceAdministration.approachSiteCode | |
| Comments | MAY contain zero or more [0..*] approachSiteCode, 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:1098-32078). |
| 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) |
| 50. SubstanceAdministration.doseQuantity | |
| Comments | MAY contain zero or one [0..1] doseQuantity (CONF:1098-32068). |
| Invariants | should-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists()) |
| 52. SubstanceAdministration.doseQuantity.unit | |
| Short | NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units |
| Comments | The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133). |
| Binding | The codes SHOULD be taken from UnitsOfMeasureCaseSensitive (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12839) |
| 54. SubstanceAdministration.rateQuantity | |
| Comments | MAY contain zero or one [0..1] rateQuantity (CONF:1098-32079). |
| Invariants | should-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists()) |
| 56. SubstanceAdministration.rateQuantity.unit | |
| Short | NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units |
| Comments | The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134). |
| Binding | The codes SHALL be taken from UnitsOfMeasureCaseSensitive (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12839) |
| 58. SubstanceAdministration.maxDoseQuantity | |
| Comments | MAY contain zero or one [0..1] maxDoseQuantity (CONF:1098-32080). |
| 60. SubstanceAdministration.administrationUnitCode | |
| Comments | MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081). |
| Binding | The codes SHALL be taken from AdministrationUnitDoseForm (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30) |
| 62. SubstanceAdministration.consumable | |
| Comments | SHALL contain exactly one [1..1] consumable (CONF:1098-32082). |
| 64. SubstanceAdministration.consumable.manufacturedProduct | |
| Comments | This consumable SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-32083). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information) |
| 66. SubstanceAdministration.performer | |
| Short | The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer. |
| Comments | MAY contain zero or more [0..*] performer (CONF:1098-30470). |
| 68. SubstanceAdministration.author | |
| Short | The author in a planned medication activity represents the clinician who is requesting or planning the medication activity. |
| Comments | SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
| 70. SubstanceAdministration.entryRelationship | |
| Short | The following entryRelationship captures any instructions associated with the planned medication activity. |
| Slicing | This element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 72. SubstanceAdministration.entryRelationship:priorityPreference | |
| Slice Name | priorityPreference |
| Short | The following entryRelationship represents the priority that a patient or a provider places on the planned medication activity. |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-31104) such that it |
| Control | 0..* |
| 74. SubstanceAdministration.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:1098-31105). |
| Fixed Value | REFR |
| 76. SubstanceAdministration.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:1098-31106). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference) |
| 78. SubstanceAdministration.entryRelationship:indication | |
| Slice Name | indication |
| Short | The following entryRelationship represents the indication for the planned medication activity. |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32069) such that it |
| Control | 0..* |
| 80. SubstanceAdministration.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:1098-32070). |
| Fixed Value | RSON |
| 82. SubstanceAdministration.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:1098-32071). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication) |
| 84. SubstanceAdministration.entryRelationship:instruction | |
| Slice Name | instruction |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it |
| Control | 0..* |
| 86. SubstanceAdministration.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:1098-32073). |
| Fixed Value | SUBJ |
| 88. SubstanceAdministration.entryRelationship:instruction.act | |
| Comments | SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32074). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction) |
| 90. SubstanceAdministration.precondition | |
| Comments | MAY contain zero or more [0..*] precondition (CONF:1098-32084). |
| 92. SubstanceAdministration.precondition.typeCode | |
| Comments | The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085). |
| Control | 1..? |
| 94. SubstanceAdministration.precondition.criterion | |
| Comments | The precondition, if present, SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32086). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration) |
Guidance on how to interpret the contents of this table can be found here
| 0. SubstanceAdministration | |
| 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())dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. ( doseQuantity.unit.exists() implies administrationUnitCode.empty())should-author: SHOULD contain author ( author.exists()) |
| 2. 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 areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. SubstanceAdministration.templateId:planned-med-activity | |
| Slice Name | planned-med-activity |
| 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 |
| 6. SubstanceAdministration.templateId:planned-med-activity.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.42 |
| 8. SubstanceAdministration.templateId:planned-med-activity.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 | 2014-06-09 |
| 10. SubstanceAdministration.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass) |
| 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 | SBADM |
| 12. SubstanceAdministration.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24) |
| 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. |
| 14. SubstanceAdministration.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1098-8575). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 16. SubstanceAdministration.text | |
| Short | SHOULD reference the portion of section narrative text corresponding to this entry |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 18. 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. |
| 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('#')) |
| 20. SubstanceAdministration.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1098-32087). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 22. SubstanceAdministration.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:1098-32088). |
| 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 |
| 24. SubstanceAdministration.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 |
| 26. SubstanceAdministration.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 |
| 28. SubstanceAdministration.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 |
| 30. SubstanceAdministration.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 |
| 32. SubstanceAdministration.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 |
| 34. SubstanceAdministration.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 |
| 36. SubstanceAdministration.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:typeattribute. |
| Label | Translation |
| 38. SubstanceAdministration.effectiveTime | |
| Control | 1..* |
| 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:typeattribute. |
| Slicing | This element introduces a set of slices on SubstanceAdministration.effectiveTime. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. SubstanceAdministration.effectiveTime:duration | |
| Slice Name | duration |
| Short | The effectiveTime in a planned medication activity represents the time that the medication activity should occur. |
| Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:1098-30468) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
| XML Format | The type of this property is determined using the " xsi:typeattribute. |
| Invariants | 1098-32890: This effectiveTime **SHALL** contain either a low or a @value but not both (CONF:1098-32890). ((value.exists() or low.exists()) and ((value.exists() and low.exists()).not()))should-value-att: SHOULD contain @value ( value.exists())should-low: SHOULD contain low ( low.exists()) |
| 42. SubstanceAdministration.effectiveTime:duration.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Short | indicates a single-administration timestamp |
| Comments | SHOULD contain zero or one [0..1] @value (CONF:1098-32775). |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 44. SubstanceAdministration.effectiveTime:duration.low | |
| Definition | This is the low limit of the interval. |
| Short | indicates when medication started |
| Comments | SHOULD contain zero or one [0..1] low (CONF:1098-32776). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| 46. SubstanceAdministration.effectiveTime:duration.high | |
| Definition | This is the high limit of the interval. |
| Short | indicates when medication stopped |
| Comments | MAY contain zero or one [0..1] high (CONF:1098-32777). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| 48. SubstanceAdministration.effectiveTime:periodicFrequency | |
| Slice Name | periodicFrequency |
| Short | This effectiveTime represents a periodic medication frequency (e.g., administration times per day). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
| XML Format | The type of this property is determined using the " xsi:typeattribute. |
| 50. SubstanceAdministration.effectiveTime:periodicFrequency.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..0 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 52. SubstanceAdministration.effectiveTime:periodicFrequency.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Comments | SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator) |
| 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 | I |
| Pattern Value | A |
| 54. SubstanceAdministration.effectiveTime:eventFrequency | |
| Slice Name | eventFrequency |
| Short | This effectiveTime represents an event-based medication frequency (e.g., administration at bedtime). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
| XML Format | The type of this property is determined using the " xsi:typeattribute. |
| 56. SubstanceAdministration.effectiveTime:eventFrequency.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..0 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 58. SubstanceAdministration.effectiveTime:eventFrequency.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Comments | SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator) |
| 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 | I |
| Pattern Value | A |
| 60. SubstanceAdministration.repeatNumber | |
| Short | In a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. |
| Comments | MAY contain zero or one [0..1] repeatNumber (CONF:1098-32066). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
| 62. SubstanceAdministration.routeCode | |
| Comments | MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from SPL Drug Route of Administration Terminology (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| Invariants | should-translation: SHOULD contain translation (translation.exists()) |
| 64. SubstanceAdministration.routeCode.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 |
| 66. SubstanceAdministration.routeCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Comments | The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952). |
| Control | 0..* |
| Binding | The codes SHOULD be taken from Medication Route (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the " xsi:typeattribute. |
| Label | Translation |
| 68. SubstanceAdministration.approachSiteCode | |
| Comments | MAY contain zero or more [0..*] approachSiteCode, 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:1098-32078). |
| 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 |
| 70. SubstanceAdministration.doseQuantity | |
| Comments | MAY contain zero or one [0..1] doseQuantity (CONF:1098-32068). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
| Invariants | should-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists()) |
| 72. SubstanceAdministration.doseQuantity.unit | |
| Definition | The unit of measure specified in the Unified Code for Units of Measure (UCUM) []. |
| Short | NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units |
| Comments | The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from UnitsOfMeasureCaseSensitive (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12839) |
| 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 | Unit of Measure |
| Default Value | 1 |
| 74. SubstanceAdministration.rateQuantity | |
| Comments | MAY contain zero or one [0..1] rateQuantity (CONF:1098-32079). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
| Invariants | should-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists()) |
| 76. SubstanceAdministration.rateQuantity.unit | |
| Definition | The unit of measure specified in the Unified Code for Units of Measure (UCUM) []. |
| Short | NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units |
| Comments | The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UnitsOfMeasureCaseSensitive (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12839) |
| 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 | Unit of Measure |
| Default Value | 1 |
| 78. SubstanceAdministration.maxDoseQuantity | |
| Comments | MAY contain zero or one [0..1] maxDoseQuantity (CONF:1098-32080). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
| 80. SubstanceAdministration.administrationUnitCode | |
| Comments | MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AdministrationUnitDoseForm (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 82. 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:1098-32082). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| 84. SubstanceAdministration.consumable.manufacturedProduct | |
| 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 |
| Comments | This consumable SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-32083). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information) |
| Is Modifier | false |
| Invariants | product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1) |
| 86. SubstanceAdministration.performer | |
| Short | The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer. |
| Comments | MAY contain zero or more [0..*] performer (CONF:1098-30470). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 88. SubstanceAdministration.author | |
| 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 | The author in a planned medication activity represents the clinician who is requesting or planning the medication activity. |
| Comments | SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
| Is Modifier | false |
| 90. SubstanceAdministration.entryRelationship | |
| Short | The following entryRelationship captures any instructions associated with the planned medication activity. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Slicing | This element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 92. SubstanceAdministration.entryRelationship:priorityPreference | |
| Slice Name | priorityPreference |
| Short | The following entryRelationship represents the priority that a patient or a provider places on the planned medication activity. |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-31104) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 94. SubstanceAdministration.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:1098-31105). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship) |
| 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 |
| 96. SubstanceAdministration.entryRelationship:priorityPreference.observation | |
| 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 |
| Comments | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31106). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference) |
| Is Modifier | false |
| Invariants | should-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())should-effectiveTime: SHOULD contain effectiveTime ( effectiveTime.exists())should-author: SHOULD contain author ( author.exists()) |
| 98. SubstanceAdministration.entryRelationship:indication | |
| Slice Name | indication |
| Short | The following entryRelationship represents the indication for the planned medication activity. |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32069) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 100. SubstanceAdministration.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:1098-32070). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship) |
| 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 |
| 102. SubstanceAdministration.entryRelationship:indication.observation | |
| 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 |
| 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:1098-32071). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication) |
| Is Modifier | false |
| Invariants | should-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())should-effectiveTime: SHOULD contain effectiveTime ( effectiveTime.exists())indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. ( value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists()))) |
| 104. SubstanceAdministration.entryRelationship:instruction | |
| Slice Name | instruction |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 106. SubstanceAdministration.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:1098-32073). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship) |
| 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 |
| 108. SubstanceAdministration.entryRelationship:instruction.act | |
| 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 |
| Comments | SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32074). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction) |
| Is Modifier | false |
| Invariants | should-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists()) |
| 110. SubstanceAdministration.precondition | |
| Comments | MAY contain zero or more [0..*] precondition (CONF:1098-32084). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 112. SubstanceAdministration.precondition.typeCode | |
| Comments | The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDAActRelationshipType (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType) |
| 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 | PRCN |
| 114. SubstanceAdministration.precondition.criterion | |
| 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 |
| Comments | The precondition, if present, SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32086). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration) |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be found here
| 0. SubstanceAdministration | |
| 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())dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. ( doseQuantity.unit.exists() implies administrationUnitCode.empty())should-author: SHOULD contain author ( author.exists()) |
| 2. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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 |
| 8. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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. SubstanceAdministration.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. 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 areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. SubstanceAdministration.templateId:planned-med-activity | |
| Slice Name | planned-med-activity |
| 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. SubstanceAdministration.templateId:planned-med-activity.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. SubstanceAdministration.templateId:planned-med-activity.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. SubstanceAdministration.templateId:planned-med-activity.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. SubstanceAdministration.templateId:planned-med-activity.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.42 |
| 30. SubstanceAdministration.templateId:planned-med-activity.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 | 2014-06-09 |
| 32. SubstanceAdministration.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass) |
| 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 | SBADM |
| 34. SubstanceAdministration.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24) |
| 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. |
| 36. SubstanceAdministration.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1098-8575). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 38. SubstanceAdministration.code | |
| Control | 0..1 |
| Binding | For example codes, see CDAActSubstanceAdministrationCode (example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 40. 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. |
| 42. SubstanceAdministration.text | |
| Short | SHOULD reference the portion of section narrative text corresponding to this entry |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 44. 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 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 |
| 46. 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 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 |
| 48. 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 |
| 50. 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 (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 |
| 52. 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 |
| 54. SubstanceAdministration.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 (example to http://terminology.hl7.org/ValueSet/v3-MediaType) |
| 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 |
| 56. SubstanceAdministration.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. |
| 58. SubstanceAdministration.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. |
| 60. 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. |
| 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('#')) |
| 62. 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 |
| 64. SubstanceAdministration.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1098-32087). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 66. SubstanceAdministration.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 |
| 68. SubstanceAdministration.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:1098-32088). |
| 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 |
| 70. SubstanceAdministration.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 |
| 72. SubstanceAdministration.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 |
| 74. SubstanceAdministration.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 |
| 76. SubstanceAdministration.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 |
| 78. SubstanceAdministration.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 namevalueSet. |
| 80. SubstanceAdministration.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 namevalueSetVersion. |
| 82. SubstanceAdministration.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 |
| 84. SubstanceAdministration.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 |
| 86. SubstanceAdministration.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:typeattribute. |
| Label | Translation |
| 88. SubstanceAdministration.effectiveTime | |
| Control | 1..* |
| 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:typeattribute. |
| Slicing | This element introduces a set of slices on SubstanceAdministration.effectiveTime. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 90. SubstanceAdministration.effectiveTime:duration | |
| Slice Name | duration |
| Short | The effectiveTime in a planned medication activity represents the time that the medication activity should occur. |
| Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:1098-30468) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
| XML Format | The type of this property is determined using the " xsi:typeattribute. |
| Invariants | 1098-32890: This effectiveTime **SHALL** contain either a low or a @value but not both (CONF:1098-32890). ((value.exists() or low.exists()) and ((value.exists() and low.exists()).not()))should-value-att: SHOULD contain @value ( value.exists())should-low: SHOULD contain low ( low.exists()) |
| 92. SubstanceAdministration.effectiveTime:duration.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 |
| 94. SubstanceAdministration.effectiveTime:duration.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Short | indicates a single-administration timestamp |
| Comments | SHOULD contain zero or one [0..1] @value (CONF:1098-32775). |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 96. SubstanceAdministration.effectiveTime:duration.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator) |
| 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 | I |
| 98. SubstanceAdministration.effectiveTime:duration.low | |
| Definition | This is the low limit of the interval. |
| Short | indicates when medication started |
| Comments | SHOULD contain zero or one [0..1] low (CONF:1098-32776). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| 100. SubstanceAdministration.effectiveTime:duration.center | |
| Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| Label | Central Value |
| 102. SubstanceAdministration.effectiveTime:duration.width | |
| Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| Label | Width |
| 104. SubstanceAdministration.effectiveTime:duration.high | |
| Definition | This is the high limit of the interval. |
| Short | indicates when medication stopped |
| Comments | MAY contain zero or one [0..1] high (CONF:1098-32777). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| 106. SubstanceAdministration.effectiveTime:periodicFrequency | |
| Slice Name | periodicFrequency |
| Short | This effectiveTime represents a periodic medication frequency (e.g., administration times per day). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
| XML Format | The type of this property is determined using the " xsi:typeattribute. |
| 108. SubstanceAdministration.effectiveTime:periodicFrequency.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 |
| 110. SubstanceAdministration.effectiveTime:periodicFrequency.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..0 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 112. SubstanceAdministration.effectiveTime:periodicFrequency.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Comments | SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator) |
| 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 | I |
| Pattern Value | A |
| 114. SubstanceAdministration.effectiveTime:periodicFrequency.event | |
| Definition | A code for a common (periodical) activity of daily living based on which the event related periodic interval is specified. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| Label | Event |
| 116. SubstanceAdministration.effectiveTime:periodicFrequency.offset | |
| Definition | An interval of elapsed time (duration, not absolute point in time) that marks the offsets for the beginning, width and end of the event-related periodic interval measured from the time each such event actually occurred. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
| Label | Offset |
| 118. SubstanceAdministration.effectiveTime:eventFrequency | |
| Slice Name | eventFrequency |
| Short | This effectiveTime represents an event-based medication frequency (e.g., administration at bedtime). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
| XML Format | The type of this property is determined using the " xsi:typeattribute. |
| 120. SubstanceAdministration.effectiveTime:eventFrequency.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 |
| 122. SubstanceAdministration.effectiveTime:eventFrequency.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..0 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 124. SubstanceAdministration.effectiveTime:eventFrequency.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Comments | SHALL contain exactly one [1..1] @operator="A" (CONF:1098-9106). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator) |
| 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 | I |
| Pattern Value | A |
| 126. SubstanceAdministration.effectiveTime:eventFrequency.phase | |
| Definition | A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| Label | Phase |
| 128. SubstanceAdministration.effectiveTime:eventFrequency.period | |
| Definition | A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| Label | Period |
| 130. SubstanceAdministration.effectiveTime:eventFrequency.alignment | |
| Definition | Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from "the 5th of every month".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar. |
| 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 | Alignment to the Calendar |
| 132. SubstanceAdministration.effectiveTime:eventFrequency.institutionSpecified | |
| Definition | Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".) |
| 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 | Institution Specified Timing |
| 134. SubstanceAdministration.priorityCode | |
| Control | 0..1 |
| Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 136. SubstanceAdministration.repeatNumber | |
| Short | In a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. |
| Comments | MAY contain zero or one [0..1] repeatNumber (CONF:1098-32066). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
| 138. SubstanceAdministration.routeCode | |
| Comments | MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from SPL Drug Route of Administration Terminology (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| Invariants | should-translation: SHOULD contain translation (translation.exists()) |
| 140. SubstanceAdministration.routeCode.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 |
| 142. SubstanceAdministration.routeCode.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 |
| 144. SubstanceAdministration.routeCode.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 |
| 146. SubstanceAdministration.routeCode.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 |
| 148. SubstanceAdministration.routeCode.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 |
| 150. SubstanceAdministration.routeCode.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 |
| 152. SubstanceAdministration.routeCode.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 namevalueSet. |
| 154. SubstanceAdministration.routeCode.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 namevalueSetVersion. |
| 156. SubstanceAdministration.routeCode.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 |
| 158. SubstanceAdministration.routeCode.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 |
| 160. SubstanceAdministration.routeCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Comments | The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952). |
| Control | 0..* |
| Binding | The codes SHOULD be taken from Medication Route (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the " xsi:typeattribute. |
| Label | Translation |
| 162. SubstanceAdministration.approachSiteCode | |
| Comments | MAY contain zero or more [0..*] approachSiteCode, 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:1098-32078). |
| 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 |
| 164. SubstanceAdministration.doseQuantity | |
| Comments | MAY contain zero or one [0..1] doseQuantity (CONF:1098-32068). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
| Invariants | should-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists()) |
| 166. SubstanceAdministration.doseQuantity.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 |
| 168. SubstanceAdministration.doseQuantity.unit | |
| Definition | The unit of measure specified in the Unified Code for Units of Measure (UCUM) []. |
| Short | NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units |
| Comments | The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from UnitsOfMeasureCaseSensitive (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12839) |
| 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 | Unit of Measure |
| Default Value | 1 |
| 170. SubstanceAdministration.doseQuantity.value | |
| Definition | The magnitude of the quantity measured in terms of the unit. |
| Control | 0..1 |
| Type | decimal(real: Real Number) |
| 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 | Maginitude Value |
| 172. SubstanceAdministration.doseQuantity.translation | |
| Definition | An alternative representation of the same physical quantity expressed in a different unit, of a different unit code system and possibly with a different value. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQR |
| Label | Translation |
| 174. SubstanceAdministration.doseQuantity.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator) |
| 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 | I |
| 176. SubstanceAdministration.doseQuantity.low | |
| Definition | This is the low limit of the interval. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ |
| Label | Low Boundary |
| 178. SubstanceAdministration.doseQuantity.center | |
| Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| Label | Central Value |
| 180. SubstanceAdministration.doseQuantity.width | |
| Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| Label | Width |
| 182. SubstanceAdministration.doseQuantity.high | |
| Definition | This is the high limit of the interval. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ |
| Label | High Boundary |
| 184. SubstanceAdministration.rateQuantity | |
| Comments | MAY contain zero or one [0..1] rateQuantity (CONF:1098-32079). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
| Invariants | should-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists()) |
| 186. SubstanceAdministration.rateQuantity.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 |
| 188. SubstanceAdministration.rateQuantity.unit | |
| Definition | The unit of measure specified in the Unified Code for Units of Measure (UCUM) []. |
| Short | NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units |
| Comments | The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UnitsOfMeasureCaseSensitive (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12839) |
| 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 | Unit of Measure |
| Default Value | 1 |
| 190. SubstanceAdministration.rateQuantity.value | |
| Definition | The magnitude of the quantity measured in terms of the unit. |
| Control | 0..1 |
| Type | decimal(real: Real Number) |
| 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 | Maginitude Value |
| 192. SubstanceAdministration.rateQuantity.translation | |
| Definition | An alternative representation of the same physical quantity expressed in a different unit, of a different unit code system and possibly with a different value. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQR |
| Label | Translation |
| 194. SubstanceAdministration.rateQuantity.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator) |
| 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 | I |
| 196. SubstanceAdministration.rateQuantity.low | |
| Definition | This is the low limit of the interval. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ |
| Label | Low Boundary |
| 198. SubstanceAdministration.rateQuantity.center | |
| Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| Label | Central Value |
| 200. SubstanceAdministration.rateQuantity.width | |
| Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| Label | Width |
| 202. SubstanceAdministration.rateQuantity.high | |
| Definition | This is the high limit of the interval. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ |
| Label | High Boundary |
| 204. SubstanceAdministration.maxDoseQuantity | |
| Comments | MAY contain zero or one [0..1] maxDoseQuantity (CONF:1098-32080). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
| 206. SubstanceAdministration.administrationUnitCode | |
| Comments | MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AdministrationUnitDoseForm (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 208. 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:1098-32082). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| 210. 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 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 |
| 212. 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 |
| 214. 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 |
| 216. SubstanceAdministration.consumable.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 |
| 218. SubstanceAdministration.consumable.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 |
| 220. SubstanceAdministration.consumable.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 |
| 222. SubstanceAdministration.consumable.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 |
| 224. SubstanceAdministration.consumable.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 |
| 226. 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 |
| 228. SubstanceAdministration.consumable.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDAParticipationType (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType) |
| 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 |
| 230. SubstanceAdministration.consumable.manufacturedProduct | |
| 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 |
| Comments | This consumable SHALL contain exactly one [1..1] Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-32083). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Medication Information) |
| Is Modifier | false |
| Invariants | product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1) |
| 232. SubstanceAdministration.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 234. SubstanceAdministration.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 236. SubstanceAdministration.performer | |
| Short | The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer. |
| Comments | MAY contain zero or more [0..*] performer (CONF:1098-30470). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 238. SubstanceAdministration.author | |
| 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 | The author in a planned medication activity represents the clinician who is requesting or planning the medication activity. |
| Comments | SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
| Is Modifier | false |
| 240. SubstanceAdministration.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 242. SubstanceAdministration.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 244. SubstanceAdministration.entryRelationship | |
| Short | The following entryRelationship captures any instructions associated with the planned medication activity. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Slicing | This element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 246. SubstanceAdministration.entryRelationship:priorityPreference | |
| Slice Name | priorityPreference |
| Short | The following entryRelationship represents the priority that a patient or a provider places on the planned medication activity. |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-31104) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 248. SubstanceAdministration.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 |
| 250. SubstanceAdministration.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 |
| 252. SubstanceAdministration.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 |
| 254. SubstanceAdministration.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 |
| 256. SubstanceAdministration.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 |
| 258. SubstanceAdministration.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 |
| 260. SubstanceAdministration.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 |
| 262. SubstanceAdministration.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 |
| 264. SubstanceAdministration.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 |
| 266. SubstanceAdministration.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:1098-31105). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship) |
| 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 |
| 268. SubstanceAdministration.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. |
| 270. SubstanceAdministration.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 |
| 272. SubstanceAdministration.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. |
| 274. SubstanceAdministration.entryRelationship:priorityPreference.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 276. SubstanceAdministration.entryRelationship:priorityPreference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 278. SubstanceAdministration.entryRelationship:priorityPreference.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 280. SubstanceAdministration.entryRelationship:priorityPreference.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 282. SubstanceAdministration.entryRelationship:priorityPreference.observation | |
| 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 |
| Comments | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31106). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference) |
| Is Modifier | false |
| Invariants | should-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())should-effectiveTime: SHOULD contain effectiveTime ( effectiveTime.exists())should-author: SHOULD contain author ( author.exists()) |
| 284. SubstanceAdministration.entryRelationship:priorityPreference.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 286. SubstanceAdministration.entryRelationship:priorityPreference.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 288. SubstanceAdministration.entryRelationship:priorityPreference.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 290. SubstanceAdministration.entryRelationship:priorityPreference.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 292. SubstanceAdministration.entryRelationship:priorityPreference.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 294. SubstanceAdministration.entryRelationship:priorityPreference.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 296. SubstanceAdministration.entryRelationship:indication | |
| Slice Name | indication |
| Short | The following entryRelationship represents the indication for the planned medication activity. |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32069) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 298. SubstanceAdministration.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 |
| 300. SubstanceAdministration.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 |
| 302. SubstanceAdministration.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 |
| 304. SubstanceAdministration.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 |
| 306. SubstanceAdministration.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 |
| 308. SubstanceAdministration.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 |
| 310. SubstanceAdministration.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 |
| 312. SubstanceAdministration.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 |
| 314. SubstanceAdministration.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 |
| 316. SubstanceAdministration.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:1098-32070). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship) |
| 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 |
| 318. SubstanceAdministration.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. |
| 320. SubstanceAdministration.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 |
| 322. SubstanceAdministration.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. |
| 324. SubstanceAdministration.entryRelationship:indication.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 326. SubstanceAdministration.entryRelationship:indication.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 328. SubstanceAdministration.entryRelationship:indication.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 330. SubstanceAdministration.entryRelationship:indication.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 332. SubstanceAdministration.entryRelationship:indication.observation | |
| 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 |
| 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:1098-32071). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication) |
| Is Modifier | false |
| Invariants | should-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())should-effectiveTime: SHOULD contain effectiveTime ( effectiveTime.exists())indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. ( value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists()))) |
| 334. SubstanceAdministration.entryRelationship:indication.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 336. SubstanceAdministration.entryRelationship:indication.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 338. SubstanceAdministration.entryRelationship:indication.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 340. SubstanceAdministration.entryRelationship:indication.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 342. SubstanceAdministration.entryRelationship:indication.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 344. SubstanceAdministration.entryRelationship:indication.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 346. SubstanceAdministration.entryRelationship:instruction | |
| Slice Name | instruction |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 348. SubstanceAdministration.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 |
| 350. SubstanceAdministration.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 |
| 352. SubstanceAdministration.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 |
| 354. SubstanceAdministration.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 |
| 356. SubstanceAdministration.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 |
| 358. SubstanceAdministration.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 |
| 360. SubstanceAdministration.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 |
| 362. SubstanceAdministration.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 |
| 364. SubstanceAdministration.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 |
| 366. SubstanceAdministration.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:1098-32073). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship) |
| 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 |
| 368. SubstanceAdministration.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. |
| 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. |
| 370. SubstanceAdministration.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 |
| 372. SubstanceAdministration.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. |
| 374. SubstanceAdministration.entryRelationship:instruction.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 376. SubstanceAdministration.entryRelationship:instruction.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 378. SubstanceAdministration.entryRelationship:instruction.act | |
| 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 |
| Comments | SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32074). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction) |
| Is Modifier | false |
| Invariants | should-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists()) |
| 380. SubstanceAdministration.entryRelationship:instruction.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 382. SubstanceAdministration.entryRelationship:instruction.observation | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
| 384. SubstanceAdministration.entryRelationship:instruction.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 386. SubstanceAdministration.entryRelationship:instruction.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 388. SubstanceAdministration.entryRelationship:instruction.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 390. SubstanceAdministration.entryRelationship:instruction.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 392. SubstanceAdministration.entryRelationship:instruction.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 394. SubstanceAdministration.entryRelationship:instruction.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 396. SubstanceAdministration.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 398. SubstanceAdministration.precondition | |
| Comments | MAY contain zero or more [0..*] precondition (CONF:1098-32084). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 400. SubstanceAdministration.precondition.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 |
| 402. SubstanceAdministration.precondition.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 |
| 404. SubstanceAdministration.precondition.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 |
| 406. SubstanceAdministration.precondition.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 |
| 408. SubstanceAdministration.precondition.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 |
| 410. SubstanceAdministration.precondition.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 |
| 412. SubstanceAdministration.precondition.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 |
| 414. SubstanceAdministration.precondition.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 |
| 416. SubstanceAdministration.precondition.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 |
| 418. SubstanceAdministration.precondition.typeCode | |
| Comments | The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CDAActRelationshipType (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType) |
| 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 | PRCN |
| 420. SubstanceAdministration.precondition.criterion | |
| 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 |
| Comments | The precondition, if present, SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32086). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration) |
| Is Modifier | false |
| 422. SubstanceAdministration.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 nameinFulfillmentOf1. |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0 based on FHIR 5.0.0. Generated 2024-05-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change