Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
Draft as of 2024-11-24 |
Definitions for the MedicationFreeTextSig 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() ) |
2. SubstanceAdministration.typeId | |
Control | 0..0 |
4. 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: |
6. SubstanceAdministration.templateId:med-freeTextSig | |
Slice Name | med-freeTextSig |
Control | 1..1 |
8. SubstanceAdministration.templateId:med-freeTextSig.root | |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.10.20.22.4.147 |
10. SubstanceAdministration.templateId:med-freeTextSig.extension | |
Control | 0..0 |
12. SubstanceAdministration.classCode | |
Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-32770). |
14. SubstanceAdministration.moodCode | |
Short | moodCode must match the parent substanceAdministration EVN or INT |
Comments | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:81-32771). |
Binding | The codes SHALL be taken from MoodCodeEvnInt (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18 ) |
16. SubstanceAdministration.code | |
Short | Instructions Medication Narrative |
Comments | SHALL contain exactly one [1..1] code (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-32775). |
Control | 1..? |
18. SubstanceAdministration.code.code | |
Control | 1..? |
Pattern Value | 76662-6 |
20. SubstanceAdministration.code.codeSystem | |
Short | LOINC |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.6.1 |
22. SubstanceAdministration.text | |
Short | SHOULD reference the portion of section narrative text corresponding to this entry |
Comments | SHALL contain exactly one [1..1] text (CONF:81-32754). |
Control | 1..? |
24. SubstanceAdministration.text.reference | |
Short | Reference into the section/text to a tag that only contains free text sig. |
Comments | This text SHALL contain exactly one [1..1] reference (CONF:81-32755). |
Control | 1..? |
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('#') ) |
26. SubstanceAdministration.text.reference.value | |
Comments | This reference SHOULD contain zero or one [0..1] @value (CONF:81-32756). |
28. SubstanceAdministration.statusCode | |
Control | 0..0 |
30. SubstanceAdministration.effectiveTime | |
Control | 0..0 |
32. SubstanceAdministration.priorityCode | |
Control | 0..0 |
34. SubstanceAdministration.repeatNumber | |
Control | 0..0 |
36. SubstanceAdministration.routeCode | |
Control | 0..0 |
38. SubstanceAdministration.approachSiteCode | |
Control | 0..0 |
40. SubstanceAdministration.doseQuantity | |
Control | 0..0 |
42. SubstanceAdministration.rateQuantity | |
Control | 0..0 |
44. SubstanceAdministration.maxDoseQuantity | |
Control | 0..0 |
46. SubstanceAdministration.administrationUnitCode | |
Control | 0..0 |
48. SubstanceAdministration.consumable | |
Comments | SHALL contain exactly one [1..1] consumable (CONF:81-32776). |
50. SubstanceAdministration.consumable.manufacturedProduct | |
Comments | This consumable SHALL contain exactly one [1..1] manufacturedProduct (CONF:81-32777). |
52. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug | |
Comments | This manufacturedProduct SHALL contain exactly one [1..1] manufacturedLabeledDrug (CONF:81-32778). |
Control | 1..? |
54. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.nullFlavor | |
Comments | This manufacturedLabeledDrug SHALL contain exactly one [1..1] @nullFlavor="NA" Not Applicable (CONF:81-32779). |
Control | 1..? |
Fixed Value | NA |
56. SubstanceAdministration.subject | |
Control | 0..0 |
58. SubstanceAdministration.specimen | |
Control | 0..0 |
60. SubstanceAdministration.performer | |
Control | 0..0 |
62. SubstanceAdministration.informant | |
Control | 0..0 |
64. SubstanceAdministration.participant | |
Control | 0..0 |
66. SubstanceAdministration.entryRelationship | |
Control | 0..0 |
68. SubstanceAdministration.precondition | |
Control | 0..0 |
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() ) |
2. 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..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
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 areUnordered and Open, and can be differentiated using the following discriminators: |
8. SubstanceAdministration.templateId:med-freeTextSig | |
Slice Name | med-freeTextSig |
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 |
10. SubstanceAdministration.templateId:med-freeTextSig.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.147 |
12. SubstanceAdministration.templateId:med-freeTextSig.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
14. SubstanceAdministration.classCode | |
Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-32770). |
Control | 1..1 |
Binding | The codes SHALL be taken from 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 |
16. SubstanceAdministration.moodCode | |
Short | moodCode must match the parent substanceAdministration EVN or INT |
Comments | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:81-32771). |
Control | 1..1 |
Binding | The codes SHALL be taken from MoodCodeEvnInt (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18 ) |
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. |
18. SubstanceAdministration.code | |
Short | Instructions Medication Narrative |
Comments | SHALL contain exactly one [1..1] code (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-32775). |
Control | 1..1 |
Binding | For example codes, see CDAActSubstanceAdministrationCode (example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
20. SubstanceAdministration.code.code | |
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
Control | 1..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code |
Pattern Value | 76662-6 |
22. SubstanceAdministration.code.codeSystem | |
Definition | Specifies the code system that defines the code. |
Short | LOINC |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System |
Pattern Value | 2.16.840.1.113883.6.1 |
24. SubstanceAdministration.text | |
Short | SHOULD reference the portion of section narrative text corresponding to this entry |
Comments | SHALL contain exactly one [1..1] text (CONF:81-32754). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
26. SubstanceAdministration.text.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Short | Reference into the section/text to a tag that only contains free text sig. |
Comments | This text SHALL contain exactly one [1..1] reference (CONF:81-32755). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
Label | Reference |
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('#') ) |
28. SubstanceAdministration.text.reference.value | |
Comments | This reference SHOULD contain zero or one [0..1] @value (CONF:81-32756). |
Control | 0..1 |
Type | url(url: Universal Resource Locator) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
30. SubstanceAdministration.statusCode | |
Control | 0..0 |
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 |
32. SubstanceAdministration.effectiveTime | |
Control | 0..0 |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
34. SubstanceAdministration.priorityCode | |
Control | 0..0 |
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
36. SubstanceAdministration.repeatNumber | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
38. SubstanceAdministration.routeCode | |
Control | 0..0 |
Binding | For example codes, see RouteOfAdministration (example to http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
40. SubstanceAdministration.approachSiteCode | |
Control | 0..0 |
Binding | For example codes, see v3 Value Set ActSite (example to http://terminology.hl7.org/ValueSet/v3-ActSite ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
42. SubstanceAdministration.doseQuantity | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
44. SubstanceAdministration.rateQuantity | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
46. SubstanceAdministration.maxDoseQuantity | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
48. SubstanceAdministration.administrationUnitCode | |
Control | 0..0 |
Binding | For example codes, see AdministrableDrugForm (example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
50. SubstanceAdministration.consumable | |
Definition | The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products. |
Comments | SHALL contain exactly one [1..1] consumable (CONF:81-32776). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
52. SubstanceAdministration.consumable.manufacturedProduct | |
Comments | This consumable SHALL contain exactly one [1..1] manufacturedProduct (CONF:81-32777). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct |
54. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug | |
Comments | This manufacturedProduct SHALL contain exactly one [1..1] manufacturedLabeledDrug (CONF:81-32778). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug |
56. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Comments | This manufacturedLabeledDrug SHALL contain exactly one [1..1] @nullFlavor="NA" Not Applicable (CONF:81-32779). |
Control | 1..1 |
Binding | The codes SHALL be taken from 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 |
Fixed Value | NA |
58. SubstanceAdministration.subject | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
60. SubstanceAdministration.specimen | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
62. SubstanceAdministration.performer | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
64. SubstanceAdministration.informant | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
66. SubstanceAdministration.participant | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
68. SubstanceAdministration.entryRelationship | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
70. SubstanceAdministration.precondition | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
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() ) |
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..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
13. 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: |
15. SubstanceAdministration.templateId:med-freeTextSig | |
Slice Name | med-freeTextSig |
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 |
17. SubstanceAdministration.templateId:med-freeTextSig.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 |
19. SubstanceAdministration.templateId:med-freeTextSig.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 |
21. SubstanceAdministration.templateId:med-freeTextSig.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 |
23. SubstanceAdministration.templateId:med-freeTextSig.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.147 |
25. SubstanceAdministration.templateId:med-freeTextSig.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
27. SubstanceAdministration.classCode | |
Comments | SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-32770). |
Control | 1..1 |
Binding | The codes SHALL be taken from 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 |
29. SubstanceAdministration.moodCode | |
Short | moodCode must match the parent substanceAdministration EVN or INT |
Comments | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:81-32771). |
Control | 1..1 |
Binding | The codes SHALL be taken from MoodCodeEvnInt (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18 ) |
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. |
31. SubstanceAdministration.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
33. SubstanceAdministration.code | |
Short | Instructions Medication Narrative |
Comments | SHALL contain exactly one [1..1] code (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-32775). |
Control | 1..1 |
Binding | For example codes, see CDAActSubstanceAdministrationCode (example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
35. SubstanceAdministration.code.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from 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 |
37. SubstanceAdministration.code.code | |
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
Control | 1..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code |
Pattern Value | 76662-6 |
39. SubstanceAdministration.code.codeSystem | |
Definition | Specifies the code system that defines the code. |
Short | LOINC |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System |
Pattern Value | 2.16.840.1.113883.6.1 |
41. SubstanceAdministration.code.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Name |
43. SubstanceAdministration.code.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Version |
45. SubstanceAdministration.code.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Display Name |
47. SubstanceAdministration.code.sdtcValueSet | |
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string(oid: ISO Object Identifier) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSet . |
49. SubstanceAdministration.code.sdtcValueSetVersion | |
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSetVersion . |
51. SubstanceAdministration.code.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Original Text |
53. SubstanceAdministration.code.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
Label | Qualifier |
55. SubstanceAdministration.code.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
57. 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. |
59. SubstanceAdministration.text | |
Short | SHOULD reference the portion of section narrative text corresponding to this entry |
Comments | SHALL contain exactly one [1..1] text (CONF:81-32754). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
61. 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 |
63. 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 |
65. 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 |
67. 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 |
69. 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 |
71. 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 |
73. 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. |
75. 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. |
77. SubstanceAdministration.text.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Short | Reference into the section/text to a tag that only contains free text sig. |
Comments | This text SHALL contain exactly one [1..1] reference (CONF:81-32755). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
Label | Reference |
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('#') ) |
79. SubstanceAdministration.text.reference.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from 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 |
81. SubstanceAdministration.text.reference.value | |
Comments | This reference SHOULD contain zero or one [0..1] @value (CONF:81-32756). |
Control | 0..1 |
Type | url(url: Universal Resource Locator) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
83. SubstanceAdministration.text.reference.useablePeriod | |
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
Control | 0..* |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable Period |
85. SubstanceAdministration.text.reference.use | |
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
Control | 0..* |
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|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 | Use Code |
87. 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 |
89. SubstanceAdministration.statusCode | |
Control | 0..0 |
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 |
91. SubstanceAdministration.effectiveTime | |
Control | 0..0 |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
93. SubstanceAdministration.priorityCode | |
Control | 0..0 |
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
95. SubstanceAdministration.repeatNumber | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
97. SubstanceAdministration.routeCode | |
Control | 0..0 |
Binding | For example codes, see RouteOfAdministration (example to http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
99. SubstanceAdministration.approachSiteCode | |
Control | 0..0 |
Binding | For example codes, see v3 Value Set ActSite (example to http://terminology.hl7.org/ValueSet/v3-ActSite ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
101. SubstanceAdministration.doseQuantity | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
103. SubstanceAdministration.rateQuantity | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
105. SubstanceAdministration.maxDoseQuantity | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
107. SubstanceAdministration.administrationUnitCode | |
Control | 0..0 |
Binding | For example codes, see AdministrableDrugForm (example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
109. SubstanceAdministration.consumable | |
Definition | The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products. |
Comments | SHALL contain exactly one [1..1] consumable (CONF:81-32776). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
111. 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 |
113. 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 |
115. 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 |
117. 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 |
119. 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 |
121. 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 |
123. 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 |
125. 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 |
127. 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 |
129. 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 |
131. SubstanceAdministration.consumable.manufacturedProduct | |
Comments | This consumable SHALL contain exactly one [1..1] manufacturedProduct (CONF:81-32777). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct |
133. SubstanceAdministration.consumable.manufacturedProduct.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 |
135. SubstanceAdministration.consumable.manufacturedProduct.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 |
137. SubstanceAdministration.consumable.manufacturedProduct.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 |
139. SubstanceAdministration.consumable.manufacturedProduct.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 |
141. SubstanceAdministration.consumable.manufacturedProduct.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 |
143. SubstanceAdministration.consumable.manufacturedProduct.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 |
145. SubstanceAdministration.consumable.manufacturedProduct.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 |
147. SubstanceAdministration.consumable.manufacturedProduct.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 |
149. SubstanceAdministration.consumable.manufacturedProduct.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
151. SubstanceAdministration.consumable.manufacturedProduct.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from RoleClassManufacturedProduct (required to http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MANU |
153. SubstanceAdministration.consumable.manufacturedProduct.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
155. SubstanceAdministration.consumable.manufacturedProduct.sdtcIdentifiedBy | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameidentifiedBy . |
157. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug | |
Comments | This manufacturedProduct SHALL contain exactly one [1..1] manufacturedLabeledDrug (CONF:81-32778). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug |
159. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Comments | This manufacturedLabeledDrug SHALL contain exactly one [1..1] @nullFlavor="NA" Not Applicable (CONF:81-32779). |
Control | 1..1 |
Binding | The codes SHALL be taken from 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 |
Fixed Value | NA |
161. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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 |
163. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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 |
165. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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 |
167. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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 |
169. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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 |
171. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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 |
173. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.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 |
175. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
177. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityClassManufacturedMaterial (required to http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MMAT |
179. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.determinerCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityDeterminerDetermined (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | KIND |
181. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.code | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
183. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug.name | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN |
185. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Material |
187. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
189. SubstanceAdministration.subject | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
191. SubstanceAdministration.specimen | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
193. SubstanceAdministration.performer | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
195. SubstanceAdministration.author | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
197. SubstanceAdministration.informant | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
199. SubstanceAdministration.participant | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
201. SubstanceAdministration.entryRelationship | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
203. SubstanceAdministration.reference | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
205. SubstanceAdministration.precondition | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
207. 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 . |