Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Draft as of 2023-09-29 |
Definitions for the PlannedMedicationActivity logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. SubstanceAdministration | |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. SubstanceAdministration.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572). |
| 4. 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) |
| 6. SubstanceAdministration.templateId | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 8. SubstanceAdministration.templateId:primary | |
| Slice Name | primary |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-30465) such that it |
| Control | 1..1 |
| 10. SubstanceAdministration.templateId:primary.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.42" (CONF:1098-30466). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.42 |
| 12. SubstanceAdministration.templateId:primary.extension | |
| Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32557). |
| Control | 1..? |
| Pattern Value | 2014-06-09 |
| 14. SubstanceAdministration.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1098-8575). |
| Control | 1..? |
| 16. SubstanceAdministration.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1098-32087). |
| Control | 1..? |
| 18. 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 |
| 20. SubstanceAdministration.effectiveTime | |
| 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, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
| 22. 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). |
| 24. 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 |
| 26. SubstanceAdministration.routeCode.translation | |
| Comments | The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHALL be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952). |
| Binding | The codes SHALL be taken from Medication Route |
| 28. 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 |
| 30. SubstanceAdministration.doseQuantity | |
| Comments | MAY contain zero or one [0..1] doseQuantity (CONF:1098-32068). |
| 32. SubstanceAdministration.doseQuantity.unit | |
| Comments | The doseQuantity, 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-32133). |
| Binding | The codes SHALL be taken from UnitsOfMeasureCaseSensitive |
| 34. SubstanceAdministration.rateQuantity | |
| Comments | MAY contain zero or one [0..1] rateQuantity (CONF:1098-32079). |
| 36. SubstanceAdministration.rateQuantity.unit | |
| 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 |
| 38. SubstanceAdministration.maxDoseQuantity | |
| Comments | MAY contain zero or one [0..1] maxDoseQuantity (CONF:1098-32080). |
| 40. 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 |
| 42. SubstanceAdministration.consumable | |
| Comments | SHALL contain exactly one [1..1] consumable (CONF:1098-32082). |
| 44. 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) |
| 46. 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). |
| 48. 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) |
| 50. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 52. 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..* |
| 54. 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 |
| 56. 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) |
| 58. 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..* |
| 60. 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 |
| 62. 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) |
| 64. SubstanceAdministration.entryRelationship:instruction | |
| Slice Name | instruction |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it |
| Control | 0..* |
| 66. 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 |
| 68. 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) |
| 70. SubstanceAdministration.precondition | |
| Comments | MAY contain zero or more [0..*] precondition (CONF:1098-32084). |
| 72. 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..? |
| Fixed Value | PRCN |
| 74. 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 | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. SubstanceAdministration.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | SBADM |
| Fixed Value | SBADM |
| 4. SubstanceAdministration.moodCode | |
| 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) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 6. SubstanceAdministration.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 8. SubstanceAdministration.templateId:primary | |
| Slice Name | primary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-30465) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. SubstanceAdministration.templateId:primary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.42" (CONF:1098-30466). |
| 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 |
| 12. SubstanceAdministration.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32557). |
| 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 |
| 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.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1098-32087). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 18. 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 |
| 20. 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 |
| 22. 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 |
| 24. 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 |
| 26. 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 |
| 28. 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 |
| 30. 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 |
| 32. 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 |
| 34. SubstanceAdministration.effectiveTime | |
| 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. |
| 36. 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 |
| 38. 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 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 40. 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 |
| 42. 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 SHALL 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 SHALL be taken from Medication Route |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 44. 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 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 46. 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 |
| 48. SubstanceAdministration.doseQuantity.unit | |
| Definition | The unit of measure specified in the Unified Code for Units of Measure (UCUM) []. |
| Comments | The doseQuantity, 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-32133). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UnitsOfMeasureCaseSensitive |
| 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 |
| 50. 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 |
| 52. SubstanceAdministration.rateQuantity.unit | |
| Definition | The unit of measure specified in the Unified Code for Units of Measure (UCUM) []. |
| 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 |
| 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 |
| 54. 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 |
| 56. 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 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 58. 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. SubstanceAdministration.consumable.manufacturedProduct | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. 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 |
| 64. SubstanceAdministration.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 68. 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 |
| 70. 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 |
| 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 |
| 72. SubstanceAdministration.entryRelationship:priorityPreference.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. 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 |
| 76. 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 |
| 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 |
| 78. SubstanceAdministration.entryRelationship:indication.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. 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 |
| 82. 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 |
| 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 |
| 84. SubstanceAdministration.entryRelationship:instruction.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. SubstanceAdministration.precondition | |
| Comments | MAY contain zero or more [0..*] precondition (CONF:1098-32084). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 88. 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 ActRelationshipType |
| 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 |
| 90. SubstanceAdministration.precondition.criterion | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
| 0. SubstanceAdministration | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. SubstanceAdministration.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | SBADM |
| Fixed Value | SBADM |
| 4. SubstanceAdministration.moodCode | |
| 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) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 6. SubstanceAdministration.realmCode | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 8. SubstanceAdministration.typeId | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. SubstanceAdministration.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 12. SubstanceAdministration.templateId:primary | |
| Slice Name | primary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-30465) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 14. SubstanceAdministration.templateId:primary.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 16. SubstanceAdministration.templateId:primary.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 18. SubstanceAdministration.templateId:primary.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 20. SubstanceAdministration.templateId:primary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.42" (CONF:1098-30466). |
| 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 |
| 22. SubstanceAdministration.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32557). |
| 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 |
| 24. SubstanceAdministration.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1098-8575). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 26. SubstanceAdministration.code | |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ActSubstanceAdministrationCode |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 28. 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. |
| 30. SubstanceAdministration.text | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 32. SubstanceAdministration.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1098-32087). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 34. 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 NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 36. 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 |
| 38. 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 |
| 40. 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 |
| 42. 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 |
| 44. 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 |
| 46. 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. |
| 48. 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. |
| 50. 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 |
| 52. 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 |
| 54. 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 |
| 56. SubstanceAdministration.effectiveTime | |
| 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. |
| 58. SubstanceAdministration.priorityCode | |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ActPriority |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 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 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 64. 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 NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 66. 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 |
| 68. 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 |
| 70. 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 |
| 72. 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 |
| 74. 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 |
| 76. 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. |
| 78. 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. |
| 80. 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 |
| 82. 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 |
| 84. 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 SHALL 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 SHALL be taken from Medication Route |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 86. 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 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 88. 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 |
| 90. 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 NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 92. SubstanceAdministration.doseQuantity.unit | |
| Definition | The unit of measure specified in the Unified Code for Units of Measure (UCUM) []. |
| Comments | The doseQuantity, 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-32133). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UnitsOfMeasureCaseSensitive |
| 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 |
| 94. 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 |
| 96. 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 SetOperator |
| 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.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 |
| 100. 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 |
| 102. 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 |
| 104. 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 |
| 106. 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 |
| 108. 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 NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 110. SubstanceAdministration.rateQuantity.unit | |
| Definition | The unit of measure specified in the Unified Code for Units of Measure (UCUM) []. |
| 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 |
| 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 |
| 112. 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 |
| 114. 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 SetOperator |
| 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 |
| 116. 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 |
| 118. 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 |
| 120. 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 |
| 122. 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 |
| 124. 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 |
| 126. 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 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 128. 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 130. SubstanceAdministration.consumable.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 132. 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 |
| 134. 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 |
| 136. 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 |
| 138. SubstanceAdministration.consumable.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationTargetDirect |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | CSM |
| 140. SubstanceAdministration.consumable.manufacturedProduct | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 142. SubstanceAdministration.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 144. SubstanceAdministration.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 146. 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 |
| 148. SubstanceAdministration.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 150. SubstanceAdministration.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 152. SubstanceAdministration.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 154. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 156. 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 |
| 158. 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 NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 160. 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 |
| 162. 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 |
| 164. 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 |
| 166. 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 |
| 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 |
| 168. 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. |
| 170. 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 |
| 172. 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. |
| 174. SubstanceAdministration.entryRelationship:priorityPreference.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 176. SubstanceAdministration.entryRelationship:priorityPreference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 178. SubstanceAdministration.entryRelationship:priorityPreference.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 180. SubstanceAdministration.entryRelationship:priorityPreference.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 182. SubstanceAdministration.entryRelationship:priorityPreference.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 184. SubstanceAdministration.entryRelationship:priorityPreference.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 186. SubstanceAdministration.entryRelationship:priorityPreference.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 188. SubstanceAdministration.entryRelationship:priorityPreference.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 190. SubstanceAdministration.entryRelationship:priorityPreference.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 192. SubstanceAdministration.entryRelationship:priorityPreference.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 194. SubstanceAdministration.entryRelationship:priorityPreference.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 196. 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 |
| 198. 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 NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 200. 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 |
| 202. 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 |
| 204. 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 |
| 206. 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 |
| 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 |
| 208. 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. |
| 210. 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 |
| 212. 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. |
| 214. SubstanceAdministration.entryRelationship:indication.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 216. SubstanceAdministration.entryRelationship:indication.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 218. SubstanceAdministration.entryRelationship:indication.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 220. SubstanceAdministration.entryRelationship:indication.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 222. SubstanceAdministration.entryRelationship:indication.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 224. SubstanceAdministration.entryRelationship:indication.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 226. SubstanceAdministration.entryRelationship:indication.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 228. SubstanceAdministration.entryRelationship:indication.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 230. SubstanceAdministration.entryRelationship:indication.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 232. SubstanceAdministration.entryRelationship:indication.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 234. SubstanceAdministration.entryRelationship:indication.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 236. 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 |
| 238. 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 NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 240. 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 |
| 242. 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 |
| 244. 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 |
| 246. 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 |
| 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 |
| 248. 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. |
| 250. 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 |
| 252. 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. |
| 254. SubstanceAdministration.entryRelationship:instruction.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 256. SubstanceAdministration.entryRelationship:instruction.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 258. SubstanceAdministration.entryRelationship:instruction.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 260. SubstanceAdministration.entryRelationship:instruction.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 262. SubstanceAdministration.entryRelationship:instruction.observation | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
| 264. SubstanceAdministration.entryRelationship:instruction.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 266. SubstanceAdministration.entryRelationship:instruction.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 268. SubstanceAdministration.entryRelationship:instruction.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 270. SubstanceAdministration.entryRelationship:instruction.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 272. SubstanceAdministration.entryRelationship:instruction.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 274. SubstanceAdministration.entryRelationship:instruction.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 276. SubstanceAdministration.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 278. SubstanceAdministration.precondition | |
| Comments | MAY contain zero or more [0..*] precondition (CONF:1098-32084). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 280. 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 NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 282. 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 ActRelationshipType |
| 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 |
| 284. 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 |
| 286. 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 |
| 288. 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 |
| 290. SubstanceAdministration.precondition.criterion | |
| Definition | Base definition for all types defined in FHIR type system. |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change